docs: add a documentation map (docs/README.adoc); refresh STATE

[hyperpolymath]

Adds the navigation layer that the doc survey flagged as the single biggest gap: docs/README.adoc maps every doc by audience (developer / maintainer / end-user) and by concept, links the existing material, and marks the planned guides against their tracking issues (#16 dev/maintainer, #17 end-user). Linked from the README. STATE.a2ml session refreshed for the close-out.

Description

Type of Change

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Refactoring (no functional changes)
• Performance improvement

Related Issues

Checklist

• My code follows the project's language policy (ReScript, Deno, no TypeScript/npm)
• I have added SPDX headers to new files
• I have updated the documentation accordingly
• I have added tests that prove my fix is effective or my feature works
• New and existing unit tests pass locally
• I have run deno fmt and deno lint on my changes

Ecological & Economic Considerations

• This change improves code efficiency
• This change has been reviewed for energy patterns
• This change maintains or improves the project's sustainability

Screenshots (if applicable)

Additional Notes

[gitar-bot]

Note

Automatic reviews are paused because your trial's included automatic processing has been used for this period. Upgrade now, or comment "Gitar review" to run a review anytime.
Learn more

Code Review ✅ Approved 1 resolved / 1 findings

Adds a documentation map (docs/README.adoc) and refreshes STATE, but the new index links to non-existent document files (EXPLAINME).

✅ 1 resolved

✅ Bug: docs/README.adoc links to non-existent doc files

📄 docs/README.adoc:14-15 📄 docs/README.adoc:20 📄 docs/README.adoc:28 📄 docs/README.adoc:51
The new documentation map links to three files that do not exist in the repo: EXPLAINME.adoc (line 14), ARCHITECTURE.adoc (lines 15, 20, and 51), and GOVERNANCE.adoc (line 28). Since the whole point of this file is to be the authoritative navigation layer, these dead links defeat its purpose and mislead readers. Either create the missing files, correct the paths/filenames if they were renamed, or move these entries under the _Planned_ sections until the docs exist.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact

gitar display:verbose

_{Was this helpful? React with 👍 / 👎 | Gitar}