Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Refactor/review linked guidance usage, and move jsonschema directive to end of sections #1467

Open
yolile opened this issue Jan 20, 2022 · 2 comments
Assignees
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues
Milestone

Comments

@yolile
Copy link
Member

yolile commented Jan 20, 2022

At the same time we can make the changes suggested in #1434 (comment):

...we want all content except the extensions list above the jsonschema directive, as otherwise it's easy to miss.)

I think we might start using a simpler format of "seealso ... How to [do X]" when linking to guidance.

Originally posted by @duncandewhurst in #1297 (comment)

We can search for "For more information". In many cases (not all), seealso would be better. There are also some {note} that start with For that can be changed to seealso.

@jpmckinney jpmckinney changed the title Docs: refactor/review linked guidance usage Docs: Refactor/review linked guidance usage, and move jsonschema directive to end of sections Jan 20, 2022
@jpmckinney jpmckinney added this to the Iterative improvements milestone Dec 8, 2022
@jpmckinney jpmckinney added the Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues label Dec 8, 2022
@jpmckinney jpmckinney self-assigned this Jun 7, 2023
@jpmckinney jpmckinney moved this to To do: Reference in OCDS 1.2 Jul 2, 2024
@duncandewhurst
Copy link
Contributor

@jpmckinney happy for me to make these changes as part of #1711?

@jpmckinney
Copy link
Member

Sure, though #1660 (and to a small extent #1680) make changes to schema/reference.md, so #1711 might end up with big conflicts if you add too much to it before those are merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues
Projects
Status: To do: Reference
Development

No branches or pull requests

3 participants