Skip to content

Latest commit

 

History

History

README.md

Documentation Index

This index explains which docs are current references vs historical phase snapshots.

Start here (current)

  1. README.md
  • Primary plugin documentation: install, usage, runtime behavior, API, env vars, troubleshooting.
  1. docs/ADMIN_MERGE_BRIEF.md
  • Merge/review summary for upstream maintainers and admins.
  1. docs/PHASE_H_VALIDATION.md
  • Final validation matrix and production readiness evidence.
  1. codextesting.md
  • Live/manual test checklist for local verification with Codex/OpenCode.

Historical phase records (context, not source of truth)

  • docs/QA.md
  • docs/PHASE_REVIEW.md
  • docs/PRODUCTION_READINESS.md

These files capture intermediate milestones and may include statuses that were true at the time but later superseded.

Rule of precedence

When documents disagree:

  1. README.md (current behavior)
  2. docs/PHASE_H_VALIDATION.md (final validation)
  3. Historical phase docs (for timeline/context only)

Updating docs after code changes

  1. Update README.md for any user-visible behavior changes.
  2. Update docs/ADMIN_MERGE_BRIEF.md for reviewer-facing deltas.
  3. Update codextesting.md if test steps or expected output changed.
  4. Add a short note in docs/PHASE_H_VALIDATION.md if validation scope/results changed materially.