Enhance the interlinking/cross-referencing across the entire documentation set
- Dominant language
- Python
- Stars
- 9
- Forks
- 7
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 56
Description
There are multiple places in the documentation that refer to features that are documented elsewhere, either within the same document or within other documents (for example, references to primitive functions). Adding cross-references to such features would enhance the usefulness of our documentation.
As a rule of thumb, the first time a feature is mentioned on a page it would be good to add a cross-reference (subsequent mentions on the same page do not need this) unless it is within a block of code – common sense applies!
This impacts the following documents:
- [ ] Dyalog APL Language Reference Guide
- [ ] Dyalog Programming Reference Guide
- [ ] Dyalog for Microsoft Windows Installation and Configuration Guide
- [ ] Dyalog for Microsoft Windows UI Guide
- [ ] Dyalog for Microsoft Windows Object Reference Guide
- [ ] Dyalog for Microsoft Windows Interfaces Guide
- [ ] Dyalog for Microsoft Windows .NET Framework Interface Guide
- [ ] Dyalog for UNIX Installation and Configuration Guide
- [ ] Dyalog for UNIX UI Guide
- [ ] Shared Code Files User Guide
- [ ] Compiler User Guide
- [ ] .NET Interface Guide
Any new documents brought across from the previous project should also be checked/amended as appropriate.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the source files for the listed Dyalog guides in the documentation repository and review how existing cross-references are written. Apply the first-mention cross-reference rule across the listed documents, including newly migrated documents, and verify that each applicable guide has been checked.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100