docs: add CHANGELOG.md and CONTRIBUTING.md to docs tree #10942
Labels
Clear labels
auto/needs-reevaluation
controller-managed
overdue
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
Needs Feedback
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.
Currently being processed by an implementer worker.
Currently being processed by the merge driver.
Currently being processed by a reviewer worker.
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.
Tracking issues used by the AI Automation system for agents to communicate and report.
Rebase conflict needs LLM conflict-resolver.
Failing CI needs implementer attention.
Documenting a driver incident or rollback.
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
CI Blocker
Critical priority issue that blocks CI/CD pipeline and prevents PR merges
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Automation
Any edits or discussion about the AI automated coding system.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Refactor
A code change that restructures existing code without changing its external behavior.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
Clear assignees
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: cleveragents/cleveragents-core#10942
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
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
5b40df10cetod7f03ee0a6