Skip to content

Complete documentation and website audit - #21

Merged
Jason-Doyle merged 2 commits into
mainfrom
docs/full-audit
Sep 25, 2026
Merged

Jason-Doyle merged 2 commits into
mainfrom
docs/full-audit

Conversation

@Jason-Doyle

@Jason-Doyle Jason-Doyle commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • add a complete authority configuration reference and a factual website privacy notice
  • correct read-path, version, deployment-template, package, support, and discovery documentation
  • document in-app and separate Worker or service authority topologies, including scaling, failure, secret, release, region, cost, and same-origin tradeoffs
  • replace the README architecture summaries with detailed identity, read, mutation, deployment, scaling, and provider flows
  • render all website Mermaid diagrams as content-addressed static SVGs with accessible captions and collapsible source, without a client-side diagram runtime
  • package the full documentation set and add persistent checks for links, anchors, headings, route metadata, configuration coverage, repository package metadata, release metadata, and generated diagram assets
  • expose privacy, issue-tracker, licence, deployment-topology, and diagram links in the static site and AI discovery files
  • align the package, website, and GitHub repository description and discovery tags with the current product

Validation

  • npm run verify:docs
  • npm run check
  • npm test (205 tests)
  • npm run build
  • npm run verify:package
  • npm run verify:scaffold
  • npm run examples:check
  • npm run benchmark:compare:local
  • npm run site:build
  • npm run site:test (15 passed, 1 intentionally skipped by project)
  • npm run site:deploy:check
  • npm run test:e2e (9 cross-browser tests)
  • npm audit --audit-level=high
  • npm --prefix site audit --audit-level=high
  • actionlint
  • 27 external documentation links checked successfully
  • 20 Mermaid diagrams rendered successfully; 16 website SVG assets verified against their source hashes
  • local Lighthouse: 100 performance, accessibility, best practices, and SEO for the homepage, authority deployment guide, and system diagrams page

@Jason-Doyle
Jason-Doyle merged commit 836462c into main Sep 25, 2026
1 check passed
@Jason-Doyle
Jason-Doyle deleted the docs/full-audit branch September 25, 2026 18:20
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.

1 participant