Dyalog / Dyalog/documentation

Make glyph pages useful

Open
#1,066 3 comments 0 reactions 0 assignees View on GitHub
lang-ref-guide
Dominant language
Python
Stars
9
Forks
7
Avg merge
1d 9h
Merged PRs (30d)
56

Description

**Page on which the enhancement should be made**
Currently, glyphs pages like https://docs.dyalog.com/21.0/language-reference-guide/symbols/plus/ are exclusively disambiguation pages that list the meanings of the glyph with examples. They are therefore excluded from the table of contents and from search.

We can then add those pages as sub-pages to https://docs.dyalog.com/21.0/language-reference-guide/glyphs/

**Describe the enhancement you would like**
We should expand those pages to include information about the glyph itself, including interesting info like:
* Unicode value and canonical name (including notes when the Unicode name is strange, like for `⍎` — APL Functional Symbol Down Tack Jot)
* The symbol's origin (e.g. traditional mathematical notation, formal logic, or bash)
* Why that symbol has [those two meanings](https://aplwiki.com/wiki/Mnemonics#Pairing_monadic_and_dyadic_meanings)
* [Mnemonics for those meanings](https://aplwiki.com/wiki/Mnemonics#Pairing_glyphs_with_their_meaning)
* Where on the keyboard that symbol is commonly found, including [mnemonics](https://aplwiki.com/wiki/Mnemonics#Pairing_glyphs/functionality_with_their_keyboard_locations)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing glyph pages, such as the linked plus page, and the Language Reference Guide glyphs page. Identify how these pages are structured and determine the consistent content needed for each glyph. Done means glyph pages provide the requested Unicode, origin, meaning, mnemonic, and keyboard information and are included under the glyphs page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.