Skip to content

docs: add CLI reference and project overview, and update README links#30

Merged
tom-nash merged 1 commit into
mainfrom
codex/review-readme-and-create-docs-folder
Apr 10, 2026
Merged

docs: add CLI reference and project overview, and update README links#30
tom-nash merged 1 commit into
mainfrom
codex/review-readme-and-create-docs-folder

Conversation

@tom-nash
Copy link
Copy Markdown
Member

Motivation

  • Improve discoverability and onboarding by providing a dedicated CLI reference and a high-level project overview.
  • Surface those documents from the main README.md so contributors and users can find detailed usage and concepts quickly.

Description

  • Add a new docs/cli-reference.md containing command usage, flags, examples, and notes for the cordon CLI.
  • Add a new docs/project-overview-and-concepts.md describing the project's goals, architecture, and contributor reading order.
  • Update README.md to include a Documentation section that links to docs/cli-reference.md and docs/project-overview-and-concepts.md.

Testing

  • This is a documentation-only change so no automated tests were required for the modifications.

Codex Task

@tom-nash tom-nash merged commit 7c9b80c into main Apr 10, 2026
4 checks passed
@tom-nash tom-nash deleted the codex/review-readme-and-create-docs-folder branch April 10, 2026 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant