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

Linking release reference and worked examples #1297

Closed
pindec opened this issue May 17, 2021 · 4 comments · Fixed by #1466
Closed

Linking release reference and worked examples #1297

pindec opened this issue May 17, 2021 · 4 comments · Fixed by #1466
Assignees
Labels
Focus - UX Making information easier to find and interpret
Milestone

Comments

@pindec
Copy link
Contributor

pindec commented May 17, 2021

It would be helpful for people reading the release reference to link to relevant worked examples, just as links are given to relevant extensions.

For example, in the parties reference, the details field notes that extensions can provide detailed classification of parties, and the party details extensions are linked. It would also be helpful to link to the organization classifications worked example.

@pindec pindec added the Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues label May 17, 2021
@jpmckinney jpmckinney added this to the Iterative improvements milestone May 19, 2021
@jpmckinney
Copy link
Member

We can create a simple Sphinx extension, where we add either Markdown frontmatter or a simple directive on the worked example, and then list the marked pages in the reference section.

Possible implementation inspiration is the example todolist directive: https://www.sphinx-doc.org/en/master/development/tutorials/todo.html

@jpmckinney jpmckinney added Focus - UX Making information easier to find and interpret and removed Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues labels Nov 22, 2021
@duncandewhurst
Copy link
Contributor

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.

@jpmckinney
Copy link
Member

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.

@yolile Can you create a new issue for this above?

@yolile
Copy link
Member

yolile commented Jan 20, 2022

Closed by #1466 and created follow up issue #1467

@yolile yolile closed this as completed Jan 20, 2022
@jpmckinney jpmckinney moved this to Done in OCDS 1.2 Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - UX Making information easier to find and interpret
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants