Dyalog / Dyalog/documentation

Replace references to other documents with links where possible

Open
#629 0 comments 0 reactions 1 assignee Claimed by @abrudz View on GitHub
compiler-guide dotnet-guide lang-ref-guide prog-ref-guide scf-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

There are multiple places in the documentation that state something along the lines of "for more information, see the Foo Guide". These should be amended to be links that go not just to the guide but to the the specific location of interest within the guide.

Such references can be identified by searching for the word "Guide".

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

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.