fix: Update README.md for improved clarity and organization of documentation structure
This commit is contained in:
@@ -21,20 +21,20 @@ planning workflow you run with the Executive Office before anything reaches the
|
||||
|
||||
```
|
||||
Local-LLC/
|
||||
├── README.md you are here
|
||||
├── COMPANY.md mission, values, philosophy
|
||||
├── FOUNDER.md the human's role and the approval gate
|
||||
├── ORGANIZATION.md every role, reporting lines, org chart
|
||||
├── WORKFLOW.md the sprint lifecycle end to end
|
||||
├── ONBOARDING.md step-by-step read order for new agents
|
||||
├── EMPLOYEE_HANDBOOK.md culture and conduct rules for AI employees
|
||||
├── PLANE.md how Plane is used (epics, stories, tasks, sprints)
|
||||
├── GITEA.md branch/commit/PR/review policy
|
||||
├── ACT_RUNNER.md CI policy: triggers, retries, failures
|
||||
├── CODING_STANDARDS.md formatting, testing, naming, architecture
|
||||
├── SECURITY.md secrets, auth, dependencies, supply chain
|
||||
├── DECISIONS.md how architecture decisions get recorded
|
||||
├── MEMORY.md the organizational memory system
|
||||
├── README.md you are here
|
||||
├── COMPANY.md mission, values, philosophy
|
||||
├── FOUNDER.md the human's role and the approval gate
|
||||
├── ORGANIZATION.md every role, reporting lines, org chart
|
||||
├── WORKFLOW.md the sprint lifecycle end to end
|
||||
├── ONBOARDING.md step-by-step read order for new agents
|
||||
├── EMPLOYEE_HANDBOOK.md culture and conduct rules for AI employees
|
||||
├── PLANE.md how Plane is used (epics, stories, tasks, sprints)
|
||||
├── GITEA.md branch/commit/PR/review policy
|
||||
├── ACT_RUNNER.md CI policy: triggers, retries, failures
|
||||
├── CODING_STANDARDS.md formatting, testing, naming, architecture
|
||||
├── SECURITY.md secrets, auth, dependencies, supply chain
|
||||
├── DECISIONS.md how architecture decisions get recorded
|
||||
├── MEMORY.md the organizational memory system
|
||||
│
|
||||
├── decisions/ the actual ADR log (numbered, append-only)
|
||||
├── templates/ ADR, project, sprint, meeting, retro, bug, RFC, roadmap
|
||||
@@ -65,8 +65,8 @@ This repo is versioned like software, not written once and frozen:
|
||||
|
||||
| Version | Milestone |
|
||||
|---|---|
|
||||
| v0.1 | Organization defined (this pass: core docs + Project Manager role) |
|
||||
| v0.2 | Remaining employee roles fleshed out |
|
||||
| **v0.1 — current** | Organization defined: all 14 root policy docs, 8 templates, the decision log, company memory seed files, and the Project Manager role fully built as the reference pattern |
|
||||
| v0.2 | Remaining employee roles fleshed out (Architect, Backend, Frontend, ML, QA, Security, DevOps, Documentation) |
|
||||
| v0.3 | Plane deployed and wired to the workflow described in PLANE.md |
|
||||
| v0.4 | Gitea/ACT Runner placeholders replaced with real instance details |
|
||||
| v0.5 | First real project run end-to-end through the full sprint lifecycle |
|
||||
|
||||
Reference in New Issue
Block a user