docs: describe the architecture diagram in text for screen readers
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- accessibility, documentation
Research direction
Find the architecture page containing the Mermaid diagram and the contributing guide at docs/contributing.md. Read the diagram and write a visible text description of the relationships beside it; update the guide to require equivalent treatment for future diagrams. Preview with npm start and run npm run build; done when both acceptance criteria are met and the build succeeds.
Written by the indexing model from the issue text.
Description
Summary
The architecture page's mermaid diagram renders as inline SVG with no accessible
description. To a screen reader it is an unlabelled graphic, so the single clearest
explanation of how the system fits together is available only to sighted readers.
Everything the diagram shows is expressible in prose — it just is not written down
anywhere in that form.
Acceptance criteria
- A text description conveys the same relationships the diagram shows, placed next to
it rather than hidden from sighted readers. - Any further diagrams added to the site get the same treatment, noted in the
contributing guide.
Getting started
Fork this repository, clone your fork, and add this repo as upstream:
git clone https://github.com/<your-username>/canopychain-docs.git
cd canopychain-docs
git remote add upstream https://github.com/Canopychain/canopychain-docs.git
Create a branch for this issue:
git checkout -b docs/describe-diagram-in-text
Suggested commit message:
docs: add a text description of the architecture diagram
Preview your changes with npm start, and run npm run build before pushing — the build
is what catches broken links. Then open a pull request from your fork against main and
link this issue. See the
contributing guide
for the full contribution guide.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Canopychain/canopychain-docs
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
All issues in Canopychain/canopychain-docs
Similar issues
-
bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
PhyberApex/kuroshiro#1687 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
microsoft/monaco-editor#5563 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 86/100
awslabs/visual-asset-management-system#937 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100