Skip to content

Docs: add an internal index for project docs#125

Merged
nerdchanii merged 1 commit into
mainfrom
codex/issue-120-project-docs-audit
May 28, 2026
Merged

Docs: add an internal index for project docs#125
nerdchanii merged 1 commit into
mainfrom
codex/issue-120-project-docs-audit

Conversation

@nerdchanii

Copy link
Copy Markdown
Owner

Summary

  • add a docs/project/README.md index that explains the purpose of each maintainer-facing project note
  • clarify the main docs structure page so maintainers have one entry point into internal docs
  • record where a future SPEC would become the source of truth without introducing a full SPEC/ADR system

Type

  • API
  • Runtime
  • Testing
  • Docs
  • Tooling
  • Packaging/release

Priority

  • P0 - Critical
  • P1 - High
  • P2 - Medium
  • P3 - Low
  • P4 - Backlog

Verification

  • Tests added or updated
  • Typecheck passes
  • Build passes
  • Docs/examples updated if needed

Release Intent

  • Changeset added
  • No release needed (docs/project-only or tooling-only and does not affect consumers)

Notes

Related issue: Closes #120

Verification:

  • npm run docs:build
  • npm run lint

@nerdchanii

Copy link
Copy Markdown
Owner Author

@codex review

Context:

@nerdchanii nerdchanii marked this pull request as ready for review May 28, 2026 20:33
@nerdchanii nerdchanii merged commit 3892123 into main May 28, 2026
2 checks passed
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. More of your lovely PRs please.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Audit and reorganize internal project docs

1 participant