Skip to content

[docs] Keep documentation aligned with current code - #371

Merged
coisa merged 1 commit into
mainfrom
codex/current-code-documentation
Oct 17, 2026
Merged

coisa merged 1 commit into
mainfrom
codex/current-code-documentation

Conversation

@coisa

@coisa coisa commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Motivation / Context

Temporary PR and release disclaimers in current documentation become stale after merge and require another editorial change during publication. The packaged documentation skill now describes the code the documentation accompanies, while checking package availability separately.

Changes

  • Apply the current-code policy to titles, introductions, metadata, badges, skill/provenance instructions and release-tool guides.
  • Write pending Changeset bodies as product changes suitable for the published changelog.
  • Preserve versioned migration guides, compatibility tables, changelog Unreleased sections and historical release notes.
  • Keep installation claims evidence-based and avoid invented versions or development-branch recipes.

Verification

  • Official skills-ref validate .agents/skills/sphinx-docs passed using version 0.1.0 from agentskills/agentskills@69ef37e9424c0a7ea9dd2293b559e43ec8176379.
  • git diff --check passed.
  • Reviewed the complete three-file diff against the current-code and history-preservation cases.
  • composer dev-tools was not run locally for this procedural text change; CI results are tracked separately.

Documentation / Generated Output

Updated the packaged skill and its documentation-update reference. No generated site output is committed.

Changelog

  • Added a Changed entry under the existing Unreleased heading.

Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 17, 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-17T16:54:13.429963Z 452af1b PR opened
🔒 Security Review ✅ Completed 2026-10-17T16:55:35.444514Z 452af1b 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.

@coderabbitai

coderabbitai Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 28d2dc0e-36ea-4b83-93c7-f81dffbb8d35
📥 Commits

Reviewing files that changed from the base of the PR and between 1e2be55 and 452af1b.

📒 Files selected for processing: 3
  • .agents/skills/sphinx-docs/SKILL.md
  • .agents/skills/sphinx-docs/references/update-triggers.md
  • CHANGELOG.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated documentation guidance to reflect code merged into the default branch, while keeping package availability claims tied to verified releases.
    • Clarified that migration details and versioned history, including unreleased entries, remain documented.
    • Updated the changelog to reflect these documentation changes.

The Sphinx documentation skill and its update guidance now direct authors to document merged code as current, independently of package publication timing. The guidance also addresses Changeset content, historical material, and verification of installation claims.

Changes: Documentation guidance

Layer / File(s) Summary
Document current code
.agents/skills/sphinx-docs/SKILL.md, .agents/skills/sphinx-docs/references/update-triggers.md, CHANGELOG.md
The skill and reference guidance cover documentation updates, Changeset content, historical material, and publication claims. The Unreleased changelog records the update.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Suggested reviewers: php-fast-forward

Merge Risk: ⚪ Minimal · up to 452af

The documentation changes distinguish current code from package publication and preserve historical material. No actionable merge risk remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main documentation change: keeping documentation aligned with current code.
Description check Passed The description covers the motivation, changes, verification, documentation impact, and changelog entry. The Related Issue and Reviewer Notes sections are missing, but the description is otherwise suf…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description covers the motivation, changes, verification, documentation impact, and changelog entry. The Related Issue and Reviewer Notes sections are missing, but the description is otherwise sufficiently complete.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

I’m a rabbit with notes in my paws,
I mark what the merged code now draws.
Release dates can wait,
While history stays straight.
Then I hop off to nibble some clover.

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

@coisa
coisa merged commit 65ba0c5 into main Oct 17, 2026
35 checks passed
@coisa
coisa deleted the codex/current-code-documentation branch October 17, 2026 17:51
@github-project-automation github-project-automation Bot moved this from Backlog to Released in PHP Fast Forward Project Oct 17, 2026
github-actions Bot added a commit that referenced this pull request Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Released

Development

Successfully merging this pull request may close these issues.

1 participant