docs(api): add ACMS/UKO API reference and update navigation #7788
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 project
No assignees
2 participants
Notifications
Due date
No due date set.
Blocks
#7973 docs(api): document ACMS/UKO API reference
cleveragents/cleveragents-core
Reference
cleveragents/cleveragents-core!7788
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
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
8a89469c5ec9327c7d6cPR 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 #7973Type/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
c9327c7d6c8e4b38e5d0New commits pushed, approval review dismissed automatically according to repository settings
8e4b38e5d03221c46cc6Re-approving after rebase onto latest master. Documentation content is unchanged - only the commit was rebased. All CI checks pass on the new commit 3221c46c.
3221c46cc6df863f169bRe-approving after rebase onto latest master (commit
df863f16). Documentation content is unchanged.