How do I navigate from the docs to the validator (and back)?

[stevieflow]

From https://docs.validator.iatistandard.org/en/latest/ I currently have to spot the link in the body to get to the validator itself:

My understanding is that the Design System has built in in-app navigation, either through the tool (langiage/search) navigation and/or the sub-navigation

I appreciate this also needs to then be replicated on the validator tool website, to give a seamless experience - but wanted to ask about the specific function on the docs site initially

One for @tillywoodfield @robredpath and maybe @IsabelBirds to consider...!

[stevieflow]

Note - this ^ is based on the assumption that the tool and docs would be presented as a whole to people, via the Design System. People don't need to care that they are different sites/things

[tillywoodfield]

When we apply the new header to the Validator itself, it will have the "Help Docs" button (shown in red below), which will link to the docs site. But you're right that we don't have anything going the other way, perhaps we could add it to the tool nav bar (shown in yellow below)? I.e. keep "IATI Validator Docs" and add "IATI Validator Home" or "IATI Validator"?

[stevieflow]

Thanks @tillywoodfield

Great that the validator itself will be clear in this way

Yes, interesting in terms of the reverse from the docs. I think you're right to try that below-the-tool name navigation - but I also wonder whether the "Help Docs" item could just be renamed to "Validator" (or similar) to give the impression that things are unified

I dunno - maybe we try both?

[tillywoodfield]

@stevieflow I discussed with @robredpath and we agreed to try the following for now:

1. Added "IATI Validator" item to the tool navigation bar (shown in yellow below)
2. Added a breadcrumb component (shown in orange below) to help with the unification and indicate that the docs site is part of the Validator

You can see these live on the IATI Validator Docs, it's not perfect but hopefully an improvement, let me know what you think.

[stevieflow]

Thanks @tillywoodfield

Yes - hopefully that will stitch things together, as you say

My inclination would be that as you click on the "docs" button in the top right hand area (from the validator - I havent the dev site to hand to add a screenshot) this in turn would then become a button to navigate you back to the application. But - that seems like (to quote @robredpath) some kind of jump scare ;)

This aspect of navigating between docs and application, when the two are seperately hosted, seems like a common issue. Is is therefore something we need to accommodate in the Design System, you both think?

Thanks again