notifications-admin icon indicating copy to clipboard operation
notifications-admin copied to clipboard

Let user choose which version of Notify docs they want to view

Open CrystalPea opened this issue 1 year ago • 4 comments

Let user choose which version of Notify docs they want to view - when sending them a link to a particular section in the docs.

What work has been done here

  • a page added where platform admin can submit a link to a section within Notify docs
  • when that that is submitted, a page is produced that can be sent to the service user
  • The service user who goes to that page can choose which language version they want to see our docs for
  • Upon selecting the language and submitting their selection, they are taken to the docs of their choice, to the section that our tech support wanted to share

Why do this work

We do this as often when sending service users links to a section in the docs, we don't know which of our clients they use, if any.

Notes

I also included "Any is fine" option to choose, for users who aren't very technical, but would still like to see the docs. It might be hard for these users to choose from a list of options they are not familiar with. Hence, I provided a "comfort" option for them. Selecting this will take them to rest API docs.

Screenshots

Link to new flow - only visible to Platform Admins

Screenshot 2024-10-03 at 14 10 48

Enter URL

Screenshot 2024-10-03 at 14 41 12

Choose language version of the docs

Screenshot 2024-10-03 at 14 47 44

CrystalPea avatar Oct 01 '24 17:10 CrystalPea

You've probably already seen this but not all the headings are consistent, so that might need to be looked at before this could be merged. No major differences, just things like #get-a-pdf-for-a-letter-notification vs #get-a-pdf-for-a-letter

klssmith avatar Oct 04 '24 14:10 klssmith

@klssmith yeah, I thought they probably aren't - we have upcoming work on the team to get API docs more in line with one another - maybe we could start with making the headers match 🙌🏼 . What do you think @saimaghafoor ? Could be a good goal for first pass over the docs?

CrystalPea avatar Oct 04 '24 15:10 CrystalPea

  • agree that we should fix the mismatched headings (comparison tool)
  • don’t think we need radio buttons here – the choices could just be links
  • I don’t like adding additional, platform-admin-only elements (the link) to user-facing pages because it confuses people on support about what users can/cannot see

quis avatar Oct 08 '24 12:10 quis

As an interim step could we automatically validate that the header exists in all the docs before generating the link?

quis avatar Oct 08 '24 13:10 quis