Skip to content

docs: fix what a Tranche 1 reviewer flagged - #308

Merged
pragalli merged 6 commits into
mainfrom
docs/307-fix-reviewer-flagged-docs
Oct 22, 2026
Merged

pragalli merged 6 commits into
mainfrom
docs/307-fix-reviewer-flagged-docs

Conversation

@pragalli

@pragalli pragalli commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Closes #307

A Tranche 1 reviewer found two misleading docs: the authorization section of TESTING.md reads as if role scenarios are not tested, and formulas in kit-spec.md fail to render on GitHub.

Changes

  • Authorization testing is described as two layers: who may call (roles) and whether a signature is required
  • Formulas use GitHub's dollar-backtick delimiters, so escaped underscores survive Markdown processing

Acceptance criteria

  • The authorization section of TESTING.md separates role checks from signature checks and points to the authorization matrix
  • No formula in kit-spec.md shows a syntax error on GitHub
  • The formulas say the same thing as before

Test plan

Automated tests

  1. npx prettier --check docs/kit-spec.md docs/TESTING.md passes with the repo config.
  2. All 29 formulas parse in KaTeX.

Manual verification

  1. Open docs/kit-spec.md in this PR's "Files changed" view, rich diff.
  2. Expect all 29 formulas rendered, with no '_' allowed only in math mode.

Breaking changes

None.

Checklist

  • Self-reviewed my own diff
  • Tests added or updated
  • Docs updated (if applicable)
  • No unrelated changes bundled in

Screenshots

None.

@vercel

vercel Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
strata-vault-kit-app Ready Ready Preview Oct 22, 2026 4:09pm UTC

Request Review

@pragalli
pragalli merged commit b212cb1 into main Oct 22, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
Preview — 83bdfb76 Deployed Oct 22, 2026 by vercel[bot]
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.

Fix the docs a Tranche 1 reviewer flagged

3 participants