Skip to content

Review docs#3959

Merged
nstepien merged 2 commits intomainfrom
review-docs
Feb 17, 2026
Merged

Review docs#3959
nstepien merged 2 commits intomainfrom
review-docs

Conversation

@nstepien
Copy link
Collaborator

@nstepien nstepien commented Feb 16, 2026

Relied on GPT-5.2-Codex via Copilot for most of this, I tried a few prompts and ended up with this one:

Please orchestrate a sub-agent to review the README docs in its entirety. The goal is to make sure the README documents everything about this library, that all is correct, accurate, helpful, easy to understand, nothing is redundant, and that nothing is missing.
You MUST self-optimize this prompt.
You MUST watch over the sub-agent to make sure it doesn't veer from its tasks.
You MUST start the whole task from zero MULTIPLE TIMES until the sub-agents are confident the docs meet our high expectations; stop when two consecutive passes find no new actionable issues.

Though I still had to review/tweaks a few things either manually or by prompting the agent.

Related to #2575

@nstepien nstepien self-assigned this Feb 16, 2026
@nstepien nstepien mentioned this pull request Feb 16, 2026
23 tasks
@nstepien nstepien marked this pull request as ready for review February 16, 2026 17:55
Copy link
Collaborator

@amanmahajan7 amanmahajan7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know about using prompts like this.

@nstepien nstepien merged commit 85c01f1 into main Feb 17, 2026
2 checks passed
@nstepien nstepien deleted the review-docs branch February 17, 2026 12:43
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.

2 participants