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

Links in RAML documentation lines fail to render if they have spaces #5

Open
peterbrightwell opened this issue Mar 12, 2020 · 2 comments

Comments

@peterbrightwell
Copy link
Contributor

E.g. https://amwa-tv.github.io/nmos-discovery-registration/branches/v1.1.x/APIs/NodeAPI.html#versioning

These use markdown syntax for links (which RAML supports) -- for the markdown docs the links are rewritten in fix-links.sh, although this approach won't immediately work for the RAML, which has already been rendered to HTML by the time this script runs.

Thanks to @garethsb-sony for spotting

@peterbrightwell
Copy link
Contributor Author

@garethsb i suspect this is now ok, what do you think?

The above link is now https://specs.amwa.tv/is-04/branches/v1.1.x/APIs/NodeAPI.html#versioning

@garethsb
Copy link
Contributor

If you follow that link you included you'll see the paragraph there still has an incorrectly rendered link to Upgrade Path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants