Dyalog / Dyalog/documentation-guidelines
Style Guide: Information on cross-references
- Dominant language
- Dockerfile
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Amend the section on cross-references in the Style Guide to cover the following:
- Referring to a section on the same page
- Refererring to a page within the same project (and a section thereof)
- Referring to a PDF
- Referring to documentation in a different GitHub project
Information should cover:
- when to end the link with a / and when .md is needed
- how to create relative links (for example, only go back to docs.dyalog.com// and never include the version number itself within the link)
Pending decsion: whether we continue with PDFs beyond v20.0, as this will impact cross-document reference format.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.