-
Notifications
You must be signed in to change notification settings - Fork 13
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
changing subheadings in reference page to include spaces #500
Conversation
Kadie - I just changed the subheadings in the reference page as a small task to practice editing the docs and bring this page in line with the style guide conventions we discussed yesterday. Not sure if I need to do anything re: translations? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The links from within tables will need to be updated to take account of the new headings. It's to do with how the HTML elements are generated from the RST and how the sphinx directives work. So, for example, if you try to follow the AddressType link from the first table on the page, it doesn't work.
In this directive:
.. jsonschema:: ../_build_schema/components.json
:pointer: /$defs/Address
:externallinks: {"type":{"url":"#addresstype","text":"AddressType"}}
:allowexternalrefs:
the 'externallinks' bit needs to change to:
:externallinks: {"type":{"url":"#address-type","text":"Address Type"}}
(This is one of the gnarly things we need to make sure we document in the Handbook!)
Thanks @kd-ods I will get those fixed |
@kd-ods I have fixed the broken links in the reference page and checked/fixed relevant links on the other pages |
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great - I've built this and checked the links. It's ready to merge.
We can do that on a call together if helpful.
Overview
(Closes/Relates to) issue: #
Translations
translating. See: https://openownership.github.io/bods-dev-handbook/translations.html
Documentation & Release
https://openownership.github.io/bods-dev-handbook/standard_releases.html