Skip to content

docs: ADRs, docs quality CI, mdBook site, and time semantics - #556

Merged
codebestia merged 1 commit into
ShadeProtocol:mainfrom
josephchimebuka:docs/509-503-502-496
Oct 22, 2026
Merged

codebestia merged 1 commit into
ShadeProtocol:mainfrom
josephchimebuka:docs/509-503-502-496

Conversation

@josephchimebuka

Copy link
Copy Markdown
Contributor

Closes #509
Closes #503
Closes #502
Closes #496

  • Create Architecture Decision Records (ADRs) #509 – Adds docs/architecture/decisions/ with an index, a template, and six ADRs (component pattern, per-merchant account, fee time-lock, two-step admin transfer, separate factories, and the two subscription systems). The rule for when an ADR is required is added to CONTRIBUTING.md.
  • Add Documentation Quality Checks to CI #503 – Adds .github/workflows/docs-quality.yml, which runs lychee, markdownlint-cli2, and typos on PRs that touch Markdown. Configs: lychee.toml, .markdownlint-cli2.jsonc, _typos.toml. Local instructions are in docs/contributing/docs-tooling.md.
  • Set Up the Documentation Site Build and Publishing #502 – Adds an mdBook site (docs/book.toml, docs/SUMMARY.md) with search, Mermaid, and edit links. Rustdoc is published under /api/. .github/workflows/docs.yml builds the site on PRs and deploys it to GitHub Pages on main. Adds make docs, make docs-serve, and make docs-check.
  • Document Time, Ledger Timestamps, and Interval Semantics #496 – Adds docs/concepts/time-and-intervals.md.

Made with Cursor

@codebestia
codebestia merged commit 70379f1 into ShadeProtocol:main Oct 22, 2026
3 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants