docs: add CHANGELOG.md and CONTRIBUTING.md to docs tree #10942
No reviewers
Labels
No labels
auto/needs-reevaluation
controller-managed
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
cleveragents/cleveragents-core!10942
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "fix/pr-10492-docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Add documentation tree mirrors of CHANGELOG.md and CONTRIBUTING.md with mkdocs.yml navigation updates.
Closes #10492
Review Summary
This PR accomplishes its goal: it adds documentation-tree mirrors of CHANGELOG.md and CONTRIBUTING.md to docs/ with clear migration headers pointing back to the authoritative root files, and updates mkdocs.yml navigation accordingly. CI is fully green across all 14 checks.
What was reviewed
Category results
Non-blocking suggestions
Missing
Type/label: The PR has no labels assigned (empty array in API response). Per PR requirements, exactly oneType/label should be applied (likelyType/Taskfor this documentation chore). This should be added before merge.Missing milestone: Both the PR and linked issue #10492 lack milestone assignment. Per CONTRIBUTING.md, milestones should be assigned to PRs.
Branch prefix: Branch is
fix/pr-10492-docsbut documentation-only changes should usefeature/mN-per CONTRIBUTING.md branch naming rules (feature/mN-<descriptive-name>). This is a pre-existing issue on the branch naming side.Docs CHANGELOG drift:
docs/CHANGELOG.mdis missing one entry present in rootCHANGELOG.md— the "Invariant Remove CLI Command" (#8530) entry. Since this change was added after the last mirror sync, the docs mirror would need to be regenerated periodically. This is not a blocker for this PR (the PR copies the root as-is at mirror time) but worth tracking as ongoing maintenance.Minor trailing newline:
docs/CONTRIBUTING.mdappears to differ from root by having an extra blank line at the end. Verify this is intentional and not an artifact.All changes are sound. Approving with the suggestions above noted for the author.
Automated review complete:
Full comments on the PR review page.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
Thank you for this contribution! Here is my review of PR #10942.
Changes Reviewed
docs/CHANGELOG.md(438 lines) — documentation-tree mirror of root CHANGELOG.md with mirror header notedocs/CONTRIBUTING.md(1573 lines) — documentation-tree mirror of root CONTRIBUTING.md with mirror header notemkdocs.yml(+2 lines) — added navigation entries for Changelog and Contributing pages between FAQ and Reference sectionsAssessment
Correctness: The diffs between root and docs versions are correct — only the mirror header lines differ (2 lines for CHANGELOG, 1 for CONTRIBUTING), confirming accurate mirroring. The mkdocs.yml nav placement is sensible (between FAQ and Reference).
Specification Alignment: The
docs/directory is the correct location for documentation files per the project file layout rules. Mirroring CONTRIBUTING.md and CHANGELOG.md into the docs tree is consistent with the documented purpose of mkdocs.CI Status: All 14 CI checks are passing (lint, typecheck, security, quality, unit_tests, integration_tests, e2e_tests, coverage, build, Docker, status-check, and more).
Non-blocking Findings
1. Missing Type/ label (required for merge)
The PR has no Type/ label applied. Per the merge requirements, exactly one Type/ label must be present. For a documentation-only change, Type/Task is appropriate.
2. Missing milestone (required for merge)
The PR and its linked issue #10492 have no milestone assigned. The merge requirements specify the PR must be assigned to the same milestone as the linked issue.
3. Missing changelog entry
The merge requirements state Changelog updated with one entry per commit. This PR is a user-facing addition (new nav pages in the documentation site) and should have a changelog entry. The root CHANGELOG.md was not modified.
4. Dependency direction on issue #10492
Issue #10492 shows no blocks or depends_on links. Per the merge requirements, the PR should be listed under the issues blocks field (PR blocks issue). The PR body correctly uses Closes #10492, but the Forgejo dependency link should be set explicitly.
5. PR dependency on parent Epic
Per CONTRIBUTING.md rule Mandatory Parent, every issue should be linked to a parent Epic via Forgejo dependency. Issue #10492 has no parent Epic linkage visible.
Summary
The core changes are correct and well-executed. However, the PR is missing several administrative requirements that block it from being merge-ready: a Type/ label, a milestone assignment, a changelog entry, and explicit Forgejo dependency links.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
Review Summary
PR #10942 adds documentation-tree mirrors of
CHANGELOG.mdandCONTRIBUTING.mdinto the/docs/tree with correspondingmkdocs.ymlnavigation updates, closing issue #10492.Change Set
docs/CHANGELOG.md— Mirror of rootCHANGELOG.mdwith a clear header identifying it as a mirrordocs/CONTRIBUTING.md— Mirror of rootCONTRIBUTING.mdwith a clear header identifying it as a mirrormkdocs.yml— Navigation entries added between FAQ and Reference sectionsReview Results
10-Category Evaluation
/docs/is the correct directory for documentation per contributing guidelinesNon-Blocking Suggestions
feature/mN-prefix (e.g.,feature/m...-add-changelog-contributing-to-docs). This PR usesfix/pr-10492-docswhich implies a bugfix. Not blocking — cosmetic.0a1 >before the mirror header). Consider trimming for exact sync.Conclusion
All checklist categories pass. The PR is a straightforward, well-scoped documentation improvement with no blocking issues. CI is fully green. Approved.
@ -0,0 +1,438 @@This file is a mirror of the authoritative root file. For the latest version, see the root CHANGELOG.md.Suggestion: Consider trimming the extra trailing blank line so this mirror is byte-identical to the root CHANGELOG.md (excluding the mirror header). Currently
tail -n +2 docs/CHANGELOG.mdproduces one extra blank line at the end vs.CHANGELOG.md. Minor drift risk when the root file is updated in the future.Suggestion: Consider adding a small anchor or redirect at the top of docs/CONTRIBUTING.md (beyond the mirror header) noting that the file is 1573 lines long and links back to the root CONTRIBUTING.md for convenience. This helps users quickly navigate to the canonical version if they need search or editing capabilities.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
5b40df10ced7f03ee0a6