Dyalog / Dyalog/documentation

Links to other documentation resources

Open
#379 0 comments 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

Some of our links go to pages/files that are Dyalog-version-dependent but are not part of this project. Some are part of the project, but are only relevant for particular releases. We have handled these previously using "/latest/" URLs, and that has worked well. However, the system needs an overhaul to make things future-proof.

All references to "/latest/" have now been removed, and all links within the MKDocs documentation should be relative to that particular release.

Plan:

For links that need to be checked each time there is a new release, include an HTML comment that follows the exact format shown:
<!--xxxVERIFYLINKxxx-->

For example: "...see [`)SAVE`](../../language-reference-guide/system-commands/save/)<!--xxxVERIFYLINKxxx-->"

Each time there is a new release, any links with this comment will be identified by a script (not yet written!) and can be checked to see whether they remain valid or should be amended/deleted.

NOTES:

- Some other links need to be updated between releases as their version number changes but they do not contain the Dyalog version number, for example, Link and Ride. A different strategy is needed to extract and validate these each release – not covered by this issue.
- There are a few places in the documentaiton that have examples or statements that include the version number. It might be useful to use variables here, but need to ensure the example does work with the new version number – not covered by this issue.

ACTION:

All internal links within the following documents need to be checked to ensure they are relative to the current release, and the <!--xxxVERIFYLINKxxx--> comment added as appropriate:

- [ ] 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 Microsoft Windows UI Guide

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

- [ ] Compose a script that identifies all occurences of the <!--xxxVERIFYLINKxxx--> string within the project

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.