Dyalog / Dyalog/documentation

Eliminate empty links (parent pages with no content) in the ToC

Open
#485 1 comment 0 reactions 1 assignee Claimed by @FionaDyalog View on GitHub
lang-ref-guide prog-ref-guide unix-inst-conf-guide unix-ui-guide win-dotnet-framework-guide win-inst-conf-guide win-interfaces-guide win-obj-ref-guide win-ui-guide
Dominant language
Python
Stars
9
Forks
7
Avg merge
1d 9h
Merged PRs (30d)
56

Description

A legacy from bringing the documentation into MKDocs from the previous system is that parent pages often have no content (sometimes sections have an "introduction" page beneath the parent).

It would be good to ensure all pages have content (and hence URLs!), especially the top-level document pages. This means going through each document and checking every parent page, then making a call on whether the "introduction" information can instead be moved up a level or new content ought to be added, etc.

All links will subsequently need to be checked/amended.

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
- [x] Dyalog for Microsoft Windows .NET Framework Interface Guide
- [ ] Dyalog for UNIX Installation and Configuration Guide
- [ ] Dyalog for UNIX Windows UI Guide
- [ ] Dyalog v20.0 Release Notes

Any new documents brought across from the previous project should also be checked/amended as appropriate.

NOTE: The impact of this exercise on the PDF and CHM files has not yet been assessed – this issue should not be actioned until that assessment has been completed and any nuances planned for.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.