Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 2.14 KB

README.md

File metadata and controls

36 lines (30 loc) · 2.14 KB

Blueprints documentation

Use this directory as the canonical technical and user documentation.

Start here

Audience Document
Trying the app User guide
Using keyboard or assistive technology Accessibility
Understanding the visual workspace Canvas engine
Importing issues and planning files Source Lens
Inspecting VaultSync backup health VaultSync integration
Diagnosing a problem Troubleshooting
Building or contributing Development guide
Understanding the code Architecture
Inspecting project files Workspace format
Reviewing trust boundaries Security model
Understanding attacker assumptions Threat model
Reviewing platform and response targets Support policy
Rotating or recovering member keys Member key lifecycle
Backing up or restoring a project Backup and disaster recovery
Activating SonarQube Cloud SonarQube Cloud
Reviewing milestone accomplishments Release history
Publishing a build Release process
Choosing the next work Roadmap

Documentation policy

  • README.md, this index, and the linked guides describe the current repository.
  • Roadmap.md is the only canonical forward plan.
  • Plan.md, ImplementationPlan.md, ProductDirection.md, IntegrationsStrategy.md, VaultSyncContext.md, AgentQuickstart.md, CodexHandoff.md, and TestPlan.md are retained as historical design and handoff material. They may contain stale status statements.
  • A behavior change is incomplete until its relevant guide and tests are updated.
  • Persisted-format changes must document compatibility, validation, sync behavior, failure handling, and security impact.

If documentation and code disagree, treat code and tests as current behavior, then fix the documentation in the same pull request.