Skip to content

Consolidate project documentation and agent guidance - #1299

Merged
ebma merged 7 commits into
stagingfrom
codex/consolidate-project-docs
Aug 3, 2026
Merged

Consolidate project documentation and agent guidance#1299
ebma merged 7 commits into
stagingfrom
codex/consolidate-project-docs

Conversation

@ebma

@ebma ebma commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

  • establish docs/README.md as the canonical documentation index and lifecycle policy
  • keep docs/api and docs/security-spec as the only documentation directory trees
  • place the small set of general documents directly under docs using the consistent kind-topic.md naming scheme
  • use explicit architecture, product, operations, adr, incident, and proposal filename prefixes
  • remove the stale memory bank, completed plans, duplicate architecture notes, obsolete audits and security snapshots, the resolved phase-race incident transcript, the redundant maintenance summary, BlindPay research, and unreferenced PR-specific QA screenshots
  • preserve every public API publication page, normative security module, current risk, current architecture/product/operations document, accepted ADR, and active proposal
  • update root and scoped CLAUDE.md files plus Cline guidance so future agents follow the structure
  • repair migrated documentation references across source comments, tests, workflows, and configuration

@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for vortex-sandbox ready!

Name Link
🔨 Latest commit c3ac73d
🔍 Latest deploy log https://app.netlify.com/projects/vortex-sandbox/deploys/6a6cb1ce1d0e160008b7246e
😎 Deploy Preview https://deploy-preview-1299--vortex-sandbox.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for vortexfi ready!

Name Link
🔨 Latest commit c3ac73d
🔍 Latest deploy log https://app.netlify.com/projects/vortexfi/deploys/6a6cb1d0c52b520008b2b35d
😎 Deploy Preview https://deploy-preview-1299--vortexfi.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for vrtx-dashboard canceled.

Name Link
🔨 Latest commit c3ac73d
🔍 Latest deploy log https://app.netlify.com/projects/vrtx-dashboard/deploys/6a6cb1ce1d0e160008b72470

@ebma
ebma requested a review from a team July 31, 2026 11:08
@ebma
ebma merged commit 935255d into staging Aug 3, 2026
6 checks passed
@ebma
ebma deleted the codex/consolidate-project-docs branch August 3, 2026 07:43
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