Skip to content

docs: cleanup pass 3, architecture history, RFCs, e2e guides, operations - #63

Merged
pavancharak merged 1 commit into
mainfrom
docs/cleanup-pass3
Sep 28, 2026
Merged

pavancharak merged 1 commit into
mainfrom
docs/cleanup-pass3

Conversation

@pavancharak

Copy link
Copy Markdown
Owner

Pass 3 of the repository docs cleanup (pass 1 was PR #61, pass 2 was PR #62).

Removed (99 files)

  • docs/architecture: the phase 2A to 2L and 3A to 3D records, the audits, certification, pipeline report, positioning validation, milestones, the older crypto and key management notes, the folder README, execution-walkthrough.md and DATABASE_SCHEMA_REFERENCE.md (both merged into the site first, see below).
  • docs/rfcs: 25 RFCs.
  • docs/guides/e2e: all 25 markdown files, 6 JSON files and the stray .m file.
  • docs/operations: all 9 files (phase 2A records, the TD1 summary, two KMS guides, three policy approval guides).

Exception, as decided: docs/rfcs/RFC-0021-Refusal-Record.md and docs/rfcs/RFC-0022-Challenge-Record.md are kept. Code cites them by section (for example packages/shared/src/domain/challenge-record.ts, "RFC-0022 § Proposal 3"), a storage test uses the path as data, and CLAIMS 3.11 cites RFC-0021.

Merged into the site first, checked against the code

  • architecture/execution-pipeline.mdx: a class by class trace of one POST /execute and a table of every point where it can stop. It is written from today's RuntimeEngine, ExecutionGateway, ExecutionControlService and SessionCredentialSecureConnector, not copied from the old walkthrough, which still named Razorpay.
  • storage/schema-reference.mdx: now the single schema reference, with every table's columns and migrations. It adds three tables neither copy had (policies, execution_intents, handbook_download_leads) and states the correct count of 31 migrations. It also drops the stale claim that no policy had been approved.
  • deployment/aws-kms-signing.mdx: troubleshooting rows for a missing gateway key file, signing and verification using different keys, and a cross service 500, plus a short "Keep in mind" list.
  • guides/policy-lifecycle-and-approvals.mdx: when enforcement is on, the full scan check, the one step review script (with a warning that refresh-approved-policy-content.ts holds both keys in one process), a troubleshooting table and a "Good to know" list.

References repointed

Citations of deleted records in CLAIMS, handbook chapters, ADR-0009, the connector docs, code comments in packages/approval, packages/api, packages/shared and packages/storage, tutorials 95, 104, 113 to 115 and 117, tests, ci.yml and .gitleaks.toml now name the record and say it is in git history, or link the site page that replaced it. The terminology guard and documentation reference tests drop the deleted files from their lists. The .gitleaks.toml allowlist entry stays because docs/site/deployment/local.mdx still uses that demo hash; only its comment changed.

No runtime behavior changes: docs, comments, tests and CI lists only. The full pre commit check passed.

🤖 Generated with Claude Code

Removes 99 files: the phase 2 and phase 3 records and other history
under docs/architecture, 25 of the 27 RFCs, all of docs/guides/e2e and
all of docs/operations. RFC-0021 and RFC-0022 stay because code cites
them by section.

Content that had to survive moved to the site first, checked against
the code: a class by class trace of one request and the points where it
can stop (architecture/execution-pipeline.mdx), every table including
policies, execution_intents and handbook_download_leads
(storage/schema-reference.mdx), KMS troubleshooting rows and cautions
(deployment/aws-kms-signing.mdx), and enforcement, the full scan check,
the one step review script, a troubleshooting table and facts from the
old developer guide (guides/policy-lifecycle-and-approvals.mdx).

Citations of deleted records in CLAIMS, the handbook, ADR-0009, the
connector docs, code comments, tutorials, tests, CI and .gitleaks.toml
now name the record and say it is in git history, or point at the site
page that replaced it.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
parmanasystems 🟢 Ready View Preview Sep 28, 2026, 9:24 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@vercel

vercel Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
parmana-api-real Ready Ready Preview Sep 28, 2026 9:24am UTC

This branch was successfully deployed

2 active deployments
staging - docs/site — 2f45133a Deployed Sep 28, 2026 by mintlify[bot]
Preview — 2f45133a Deployed Sep 28, 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.

1 participant