Skip to content

docs(reference): add third-party audit summary page - #119

Open
theo372001 wants to merge 1 commit into
wraith-protocol:developfrom
theo372001:feat/issue-86-audit-summary-page
Open

docs(reference): add third-party audit summary page#119
theo372001 wants to merge 1 commit into
wraith-protocol:developfrom
theo372001:feat/issue-86-audit-summary-page

Conversation

@theo372001

Copy link
Copy Markdown

Summary

Adds a curated, non-technical summary page for Wraith Protocol's contract audits, per #86.

  • New reference/audits.mdx — one section per audit with firm, date, scope, findings summary (severity + description per finding), and remediation status, linking to the raw report.
  • Note: the repo currently has exactly one completed audit — a Stellar Asset Contract (SAC) compatibility review conducted internally by the Wraith Protocol security team, not by a third-party firm. The page states this explicitly rather than overstating it, per the "copy reviewed for accuracy vs raw reports" acceptance criterion. Additional third-party audits are noted as planned, with a pointer to the roadmap.
  • Nav entry added under "Reference" in docs.json.
  • While editing that nav array I found (and fixed) a pre-existing invalid-JSON syntax error in the same "Reference" group — a duplicate/malformed pages key left over from a bad merge in 5c5c7f1/23d0a1f, which broke docs.json parsing entirely (unrelated content, e.g. contracts/evm/contracts/stellar/etc., remains reachable via the separate, untouched "Contracts" group). Had to fix it since it's the exact object this PR's nav entry needed to go into.

Type

  • Documentation

Related Issue

Closes #86

Testing

  • node -e "JSON.parse(...)" on docs.json: now valid (was failing before this fix).
  • mint validate: the only remaining failures are pre-existing and unrelated, confirmed via git stash comparison against clean develop — a genuine MDX parse error in contracts/stellar.mdx (stray ! character) and a dangling nav reference to reference/stellar-event-schemas, a file that has never existed in the repo. My new reference/audits entry produces zero warnings.
  • mint broken-links couldn't complete, blocked by the same pre-existing contracts/stellar.mdx parse error.
  • Findings summary cross-checked against the raw report (contracts/stellar/audits/2026-06-sac-compatibility.md) for firm name, date, and all 7 finding IDs/severities.

…otocol#86)

Summarizes the Stellar Asset Contract (SAC) compatibility review for
non-technical readers, with severity, findings, and remediation status
per finding, and a link to the raw report in contracts/stellar/audits.

Also fixes a pre-existing invalid-JSON syntax error in the docs.json
Reference nav group (duplicate/malformed pages key from a bad merge in
5c5c7f1 / 23d0a1f) and adds the new audits page's nav entry.
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.

Third-party audit summary page

1 participant