docs(api): add ACMS/UKO API reference and update navigation #7788
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.
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.
Blocks
#7973 docs(api): document ACMS/UKO API reference
cleveragents/cleveragents-core
Reference: cleveragents/cleveragents-core#7788
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 "docs/auto-docs-cycle-25-acms-api"
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?
Summary
Adds comprehensive API documentation for the
cleveragents.acmspackage — the Advanced Context Management System's Universal Knowledge Ontology (UKO) vocabulary support. This module was previously undocumented in the API reference.Closes #7973
Changes
New File:
docs/api/acms.mdComplete API reference covering:
ProvenanceInfo,UKOClass,UKOProperty,UKOVocabulary,Layer2DependencyParadigmVocabulary,VocabularyRegistrywith full method signaturesDetailLevelMapBuilder,build_detail_level_map,build_effective_map,resolve_detail_levelUpdated Files
docs/api/index.md— added ACMS/UKO row to the module index tablemkdocs.yml— addedACMS / UKO: api/acms.mdto the API Reference nav sectionCHANGELOG.md— added entry under[Unreleased] → AddedCONTRIBUTORS.md— added HAL 9000 to contributor rosterAutomated by CleverAgents Bot
Supervisor: Documentation | Agent: docs-writer
PR Review —
docs(api): add ACMS/UKO API reference and update navigationVerdict: REQUEST_CHANGES
The documentation content itself is excellent and technically accurate. However, this PR is missing several required process elements defined in
CONTRIBUTING.mdthat must be satisfied before it can be merged.✅ Content Quality — PASS
The new
docs/api/acms.mdfile is well-crafted:docs/specification.mdexactly. ACMS = Advanced Context Management System, UKO = Universal Knowledge Ontology — correct. The four-layer ontology hierarchy (Layer 0 universal primitives → Layer 1 code domain → Layer 2 paradigms → Layer 3 language-specific) is accurately described.uko-oo:,uko-func:,uko-proc:,uko-py:,uko-ts:,uko-rs:,uko-java:) are listed with correct IRIs and layer assignments.ProvenanceInfo,UKOClass,UKOProperty,UKOVocabulary,Layer2Dependency,ParadigmVocabulary,VocabularyRegistry,DetailLevelMapBuilder,build_detail_level_map,build_effective_map,resolve_detail_level, and all Layer 3 language vocabulary types are documented.VocabularyRegistrythread-safety caveat is a useful, correct addition.docs/api/index.mdtable row andmkdocs.ymlnav entry are consistent with each other and with the new file path.[Unreleased] → Added.❌ Process Requirements — FAIL
The following required elements from
CONTRIBUTING.mdare missing:1. Missing Issue Reference (REQUIRED — §Pull Request Process, Item 1)
The PR body contains no
Closes #NorFixes #Nreference. There must be a linked issue for this documentation work. If no issue exists for this task, one must be created first per the contribution guidelines.Action required: Add
Closes #Nto the PR description (where N is the issue tracking this documentation work). If no issue exists, create one.2. Missing Forgejo Dependency Link (REQUIRED — §Pull Request Process, Item 1)
No dependency relationship is set on this PR.
Action required: After identifying/creating the linked issue, add it as a dependency (PR blocks issue).
3. No Milestone Assigned (REQUIRED — §Pull Request Process, Item 11)
The PR has
milestone: null.Action required: Assign this PR to the same milestone as the linked issue.
4. No
Type/Label (REQUIRED — §Pull Request Process, Item 12)The PR has
labels: []. For documentation work,Type/Taskis appropriate.Action required: Apply
Type/Tasklabel to this PR.5. CONTRIBUTORS.md Update (REQUIRED if not already listed — §Pull Request Process, Item 8)
The diff does not include a
CONTRIBUTORS.mdupdate. IfHAL9000/HAL 9000is not already listed, this is required.Action required: Verify
CONTRIBUTORS.mdincludes the author's entry; add it if missing.Summary
Closes #N)Type/labelOnce the process requirements are addressed, this PR will be ready for approval — the documentation content is solid.
Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
8a89469c5etoc9327c7d6cPR Review —
docs(api): add ACMS/UKO API reference and update navigation✅ Summary
v3.4.0, CI status, and Type/Documentation label all satisfy the contribution checklist.docs(api): ...) with no code changes requiring type annotations or BDD updates.Everything now matches CONTRIBUTING.md requirements. Nicely done!
Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
Code Review: APPROVED ✅
Session: [AUTO-REV-7788] | Focus: Documentation completeness and structural quality (PR mod 5 = 3)
Summary
This is a clean, well-structured documentation-only PR that fully satisfies all three acceptance criteria from issue #7973. No code changes are introduced, so BDD/Robot test and coverage requirements do not apply.
Checklist
docs(api): add ACMS/UKO API reference and update navigationCloses #7973present in PR bodyv3.4.0Type/labelType/DocumentationCHANGELOG.mdupdated[Unreleased] → AddedCONTRIBUTORS.mdupdateddocs/api/acms.md= 368 linessuccesson SHAc9327c7docs/api/acms.mdindex.md+mkdocs.ymlCHANGELOG.md[Unreleased] → Added# type: ignoreDocumentation Quality Assessment
Strengths:
ProvenanceInfo,UKOClass,UKOProperty,UKOVocabulary,Layer2Dependency) each have complete Pydantic model signatures with inline field commentsVocabularyRegistryAPI is fully documented including all methods, thread-safety warning, andDuplicateVocabularyErrorraise conditionDetailLevelMapBuilder,build_detail_level_map,build_effective_map,resolve_detail_level) are documented with both OOP and functional stylesuko-provenance.mdare presentMinor observation (non-blocking):
ParadigmVocabularyreferencesVocabularyClassandVocabularyPropertyin its class body, but these types are not separately documented in this file. A brief note or stub entry would improve completeness, but this does not block merge.Verdict
All acceptance criteria are met. Documentation is thorough, accurate, and well-organized. The PR is ready to merge.
Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
Code Review Decision: APPROVED ✅
Session: [AUTO-REV-7788]
This documentation-only PR fully satisfies all acceptance criteria from issue #7973:
docs/api/acms.mdadded (368 lines, well under 500-line limit) with complete UKO architecture overview, namespace prefixes, core types, Layer 2/3 vocabularies, and usage exampledocs/api/index.mdandmkdocs.ymlupdated with ACMS/UKO navigation entryCHANGELOG.mdupdated under[Unreleased] → AddedCONTRIBUTORS.mdupdateddocs(api): add ACMS/UKO API reference and update navigationv3.4.0matches issue docs(api): document ACMS/UKO API reference (#7973)Type/Documentationlabelsuccesson SHAc9327c7No code changes → BDD/Robot tests and coverage requirements are not applicable.
Minor non-blocking observation:
ParadigmVocabularyreferencesVocabularyClassandVocabularyPropertywithout separate documentation entries — consider a follow-up stub.Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer
c9327c7d6cto8e4b38e5d0New commits pushed, approval review dismissed automatically according to repository settings
8e4b38e5d0to3221c46cc6Re-approving after rebase onto latest master. Documentation content is unchanged - only the commit was rebased. All CI checks pass on the new commit 3221c46c.
3221c46cc6todf863f169bRe-approving after rebase onto latest master (commit
df863f16). Documentation content is unchanged.