forked from eva/focus-flow
55 lines
1.1 KiB
Markdown
55 lines
1.1 KiB
Markdown
# Codex Documentation
|
|
|
|
This folder contains Codex-facing execution plans and implementation guidance.
|
|
|
|
## Required structure
|
|
|
|
```text
|
|
Codex Documentation/
|
|
├── README.md
|
|
├── Current Software Plan/
|
|
├── Completed Plans/
|
|
└── Archived plans/
|
|
```
|
|
|
|
## Current Software Plan
|
|
|
|
Active implementation plans live in:
|
|
|
|
```text
|
|
Codex Documentation/Current Software Plan/
|
|
```
|
|
|
|
Codex should execute the current plans in numbered order unless the user explicitly says otherwise.
|
|
|
|
## Archived plans
|
|
|
|
Completed implementation plans must be moved to:
|
|
|
|
```text
|
|
Codex Documentation/Archived plans/
|
|
```
|
|
|
|
This is not optional. Completed plans must not remain in Current Software Plan.
|
|
|
|
## Completed Plans
|
|
|
|
Curated completed-plan copies live in:
|
|
|
|
```text
|
|
Codex Documentation/Completed Plans/
|
|
```
|
|
|
|
This folder is a current-state snapshot, not a full archive mirror. It should
|
|
exclude superseded, stale, or refactored-away archive documents.
|
|
|
|
## Plan status convention
|
|
|
|
Each plan file should clearly indicate whether it is:
|
|
|
|
- `Planned`
|
|
- `In progress`
|
|
- `Complete`
|
|
- `Archived`
|
|
|
|
When finished, mark complete, move to archive, and commit the move.
|