Skip to content

docs: tests and code are the doc; no behaviour or architecture docs - #81

Merged
altaywtf merged 1 commit into
mainfrom
docs/no-mirror-docs
Oct 25, 2026
Merged

altaywtf merged 1 commit into
mainfrom
docs/no-mirror-docs

Conversation

@altaywtf

Copy link
Copy Markdown
Member

put.io repos stop keeping docs that restate code or tests.

Before After
Only docs/distribution.md was banned Behaviour specs, architecture overviews, testing guides, and harness catalogs go too
A doc could hold rules that tests pin The test is the doc for a rule it pins
Extra docs had no stated purpose Extra docs serve shipped-package users or license text
  • Human-only steps and hazards no check catches still get a line in AGENTS.md or CONTRIBUTING.md.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-25T14:55:48.715460Z 5359081 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@altaywtf
altaywtf merged commit 72f20b3 into main Oct 25, 2026
1 check passed
@altaywtf
altaywtf deleted the docs/no-mirror-docs branch October 25, 2026 14:58
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.

1 participant