docs: reconcile documentation with reality (P3)
Make the project's documentation match the code and remove the sprawl. The docs
claimed Phase 2.8 (drug interactions) was 'planning/0%' and the backend '~91%
complete' — both wrong: 2.8 is implemented and live, plus the P0/P1 security
and test work is done. Five root CI/CD docs described a 'docker-build' CI job
that was removed; ~18 backend/ status snapshots and ~24 docs/implementation
duplicates cluttered the tree.
Deletions (85 files):
- Root: 4 stale CI/CD reports (CI-CD-{COMPLETION-REPORT,IMPLEMENTATION-SUMMARY,
STATUS-REPORT,FINAL-STATUS}.md) — all describe the removed docker-build job.
- backend/: 18 phase/build/fix snapshots and code-dump .txt files.
- docs/: the 3 one-time reorg reports; ~17 docs/implementation duplicates and
process artifacts; 4 stale docs/development CI docs + git snapshots;
redundant deployment/testing files.
- thoughts/: STATUS.md (said Phase 2.4 in-progress), superseded phase notes and
duplicative research inputs. tmp/ (928KB of CI debug logs, gitignored).
Moves (18 files):
- 9 genuine decision records -> docs/adr/ (Architecture Decision Records),
date-prefixes stripped, with an index README.
- 8 historical-but-valuable phase plans/specs + the old CI-CD-FINAL-SOLUTION ->
docs/archive/ (now-populated, with a README explaining it's superseded
material). thoughts/ tree removed.
Rewrites (13 files) to match reality:
- Drop the fake '% complete' figures everywhere in favor of Implemented /
In-Progress / Planned with concrete endpoint/feature lists.
- Phase 2.8 -> Implemented; add /api/interactions/* and /api/auth/{refresh,
logout} to the endpoint lists; fix 'Rust 1.93' -> edition 2021.
- Add a Security section (token_version validation, hashed refresh-token
persistence, fail-fast config, real-IP audit) and correct the test-coverage
and deployment claims to reality.
- New canonical docs/development/CI-CD.md (4 jobs: format/clippy/build/test,
mongo service, no docker-build + why).
- README, docs/README, product/{STATUS,ROADMAP,PROGRESS,README,introduction},
implementation/README, development/README, testing/README, AI_AGENT_GUIDE,
.cursorrules, .gooserules all updated.
Verified: greps for 'Phase 2.8 (Planning)', 'PLANNING (0%)', 'Rust 1.93',
'91%/10%/85% complete', and 'docker-build' return nothing outside docs/archive;
all internal doc links resolve; backend/src untouched (cargo build clean).
This commit is contained in:
parent
bd1b7c2925
commit
17efc4f656
119 changed files with 469 additions and 17801 deletions
|
|
@ -4,22 +4,13 @@ This section contains development workflow documentation, Git guidelines, and CI
|
|||
|
||||
## 📚 Workflow Documentation
|
||||
|
||||
### Git Workflow
|
||||
- **[GIT-STATUS.md](./GIT-STATUS.md)** - Git workflow reference
|
||||
- **[GIT-LOG.md](./GIT-LOG.md)** - Git log history
|
||||
- **[GIT-COMMAND.txt](./GIT-COMMAND.txt)** - Useful Git commands
|
||||
- **[GIT-STATUS.txt](./GIT-STATUS.txt)** - Git status reference
|
||||
|
||||
### Commit Guidelines
|
||||
- **[COMMIT-INSTRUCTIONS.txt](./COMMIT-INSTRUCTIONS.txt)** - Commit message guidelines
|
||||
- **[commit_message.txt](./commit_message.txt)** - Commit message template
|
||||
- **[COMMIT-NOW.sh](./COMMIT-NOW.sh)** - Quick commit script
|
||||
|
||||
## 🔄 CI/CD
|
||||
|
||||
### Forgejo Configuration
|
||||
- **[FORGEJO-CI-CD-PIPELINE.md](./FORGEJO-CI-CD-PIPELINE.md)** - CI/CD pipeline documentation
|
||||
- **[FORGEJO-RUNNER-UPDATE.md](./FORGEJO-RUNNER-UPDATE.md)** - Runner update notes
|
||||
- **[CI-CD.md](./CI-CD.md)** - The current CI/CD pipeline (format / clippy / build / test)
|
||||
|
||||
## 🌳 Branch Strategy
|
||||
|
||||
|
|
@ -80,11 +71,6 @@ git add .
|
|||
git commit -m "feat(scope): description"
|
||||
```
|
||||
|
||||
Or use the quick commit script:
|
||||
```bash
|
||||
./docs/development/COMMIT-NOW.sh
|
||||
```
|
||||
|
||||
### 4. Push and Create PR
|
||||
```bash
|
||||
git push origin feature/your-feature-name
|
||||
|
|
@ -138,4 +124,4 @@ git branch -d feature/your-feature-name
|
|||
|
||||
---
|
||||
|
||||
*Last Updated: 2026-03-09*
|
||||
*Last Updated: 2026-06-27*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue