Skip to content

docs: review and improve documentation accessibility and plain-language clarity#44

Open
MD-Mushfiqur123 wants to merge 1 commit into
needsofmany:masterfrom
MD-Mushfiqur123:docs/accessibility-review
Open

docs: review and improve documentation accessibility and plain-language clarity#44
MD-Mushfiqur123 wants to merge 1 commit into
needsofmany:masterfrom
MD-Mushfiqur123:docs/accessibility-review

Conversation

@MD-Mushfiqur123
Copy link
Copy Markdown

Closes #42

Improves documentation readability, accessibility, and clarity across README, START_HERE, docs/, and website/ files.

Changes made

Duplicate content removed:

  • docs/regular-user-guide.md: Removed duplicated Export First, Refine Later section
  • docs/json-export.md: Removed duplicated Re-running Exports section

Navigation consistency improved:

  • Added missing Start Here, Contributing, and Discussions links to all website/docs/ sub-page navigations (8 HTML files)
  • Added missing Contributing link to website/help-me-export.html

Next steps added to documentation:

  • docs/api-token.md: Added Where to go next linking to install, JSON export, and privacy docs
  • docs/data-model.md: Added Where to go next linking to SQL Server import, JSON export, and developer guide

Plain-language improvements:

  • README.md: Changed regular-user guide to plain-language guide for clarity
  • docs/shutdown-and-preservation.md: Simplified shutdown announcement wording

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review documentation for accessibility and plain-language clarity

1 participant