[AUTO-DOCS-1] Fix documentation nav, broken anchors, and missing showcase page #10340

Closed
HAL9000 wants to merge 1 commit from auto-docs-1/fix-mkdocs-nav-and-links into main
Owner

Summary

Changes Made

  1. Fixed mkdocs.yml navigation — Added complete Showcase section to the nav with all 16 CLI tools showcase pages, API Clients, Data Processing, and Testing Tools categories. The entire showcase directory was previously missing from the nav.

  2. Created missing showcase page — Added docs/showcase/cli-tools/config-and-automation-profiles.md with comprehensive documentation covering:

    • Global configuration system and scoping
    • Automation profiles (built-in and custom)
    • Safety profiles and guard enforcement
    • Profile precedence chain
    • Semantic escalation behavior
    • Complete end-to-end example
  3. Fixed 12 broken internal anchor links — Fixed broken #anchor links in the Milestone Plan section of specification.md. The anchors referenced headings that don't exist; corrected to point to actual existing headings:

    • #decision-tree-and-correction#the-plan-decision-tree-and-visualization
    • #invariant-system#layer-3-invariant-enforcement
    • #validation-abstraction#validation
    • #subplan-architecture#plan-hierarchy-and-parallelism
    • #checkpoint-and-rollback#checkpointing-in-execute-core-safety-mechanism
    • #merge-strategies#child-plan-result-merging
    • #correction-model#correcting-plans-core-feature
    • #uko-universal-knowledge-ontology#universal-knowledge-ontology-uko
    • #context-storage-tiers#temporal-data-model-and-storage-tiers
    • #safety-profiles#safety-profile-composed-sub-model
    • #guard-enforcement#automation-guard-sub-model
    • #event-queue#event-system
    • #devcontainer-integration#devcontainer-auto-discovery
    • #container-resource-types#cloud-infrastructure-resource-types
    • #advanced-context-strategies#built-in-strategy-catalogue
    • #provider-registry#plugin-architecture-overview
    • #tui-materializer#integration-with-future-tui

Automated by CleverAgents Bot
Supervisor: Documentation | Agent: AUTO-DOCS-1


Automated by CleverAgents Bot
Agent: pr-creator

## Summary ### Changes Made 1. **Fixed mkdocs.yml navigation** — Added complete Showcase section to the nav with all 16 CLI tools showcase pages, API Clients, Data Processing, and Testing Tools categories. The entire showcase directory was previously missing from the nav. 2. **Created missing showcase page** — Added `docs/showcase/cli-tools/config-and-automation-profiles.md` with comprehensive documentation covering: - Global configuration system and scoping - Automation profiles (built-in and custom) - Safety profiles and guard enforcement - Profile precedence chain - Semantic escalation behavior - Complete end-to-end example 3. **Fixed 12 broken internal anchor links** — Fixed broken `#anchor` links in the Milestone Plan section of `specification.md`. The anchors referenced headings that don't exist; corrected to point to actual existing headings: - `#decision-tree-and-correction` → `#the-plan-decision-tree-and-visualization` - `#invariant-system` → `#layer-3-invariant-enforcement` - `#validation-abstraction` → `#validation` - `#subplan-architecture` → `#plan-hierarchy-and-parallelism` - `#checkpoint-and-rollback` → `#checkpointing-in-execute-core-safety-mechanism` - `#merge-strategies` → `#child-plan-result-merging` - `#correction-model` → `#correcting-plans-core-feature` - `#uko-universal-knowledge-ontology` → `#universal-knowledge-ontology-uko` - `#context-storage-tiers` → `#temporal-data-model-and-storage-tiers` - `#safety-profiles` → `#safety-profile-composed-sub-model` - `#guard-enforcement` → `#automation-guard-sub-model` - `#event-queue` → `#event-system` - `#devcontainer-integration` → `#devcontainer-auto-discovery` - `#container-resource-types` → `#cloud-infrastructure-resource-types` - `#advanced-context-strategies` → `#built-in-strategy-catalogue` - `#provider-registry` → `#plugin-architecture-overview` - `#tui-materializer` → `#integration-with-future-tui` --- **Automated by CleverAgents Bot** Supervisor: Documentation | Agent: AUTO-DOCS-1 --- **Automated by CleverAgents Bot** Agent: pr-creator
- Add Showcase section to mkdocs.yml nav with all CLI tools pages
  including the missing config-and-automation-profiles.md entry
- Create docs/showcase/cli-tools/config-and-automation-profiles.md
  with comprehensive documentation on configuration and automation
  profiles, safety profiles, and guard enforcement
- Fix 12 broken internal anchor links in specification.md Milestone
  Plan section: corrected anchors for Decision Tree, Invariant System,
  Validation, Subplan Architecture, Checkpoint, Merge Strategies,
  Correction Model, UKO Ontology, Storage Tiers, Safety Profiles,
  Guard Enforcement, Event Queue, Devcontainer Integration, Container
  Resource Types, Advanced Context Strategies, Provider Registry, and
  TUI Materializer to point to actual existing headings
HAL9000 added this to the v3.9.0 milestone 2026-04-18 09:00:34 +00:00
Author
Owner

[GROOMED] Quality Analysis Complete

Analysis Summary

Current Status

  • PR: #10340 "[AUTO-DOCS-1] Fix documentation nav, broken anchors, and missing showcase page"
  • Created: 2026-04-18 (today)
  • State: Open
  • Changes: 293 additions, 6 deletions across 3 files

Issues Found & Fixed

Milestone Assignment

  • Status: FIXED
  • Action: Assigned to milestone v3.9.0 (documentation and feature updates)
  • Reason: This PR contains pure documentation improvements

⚠️ Labels (Attempted)

  • Status: BLOCKED - Label API endpoints are restricted
  • Required Labels:
    • State/In Review (id: 844) - PR awaiting peer review
    • Type/Documentation (id: 852) - Documentation improvement
    • Priority/Medium (id: 860) - Standard priority for docs
  • Note: Label endpoints are blocked by system permissions. Manual label assignment may be required.

PR Content Validation

  • Description: Well-structured with clear summary of changes
  • Changes:
    1. Fixed mkdocs.yml navigation (added complete Showcase section)
    2. Created missing showcase page for config-and-automation-profiles
    3. Fixed 12 broken internal anchor links in specification.md
  • Quality: High - specific, detailed, and well-documented

Review Status

  • Reviewers: None assigned (expected for new PR)
  • Comments: None yet (expected for new PR)
  • Mergeable: Yes

Recommendations

  1. Milestone assigned to v3.9.0
  2. ⚠️ Labels need manual assignment (API blocked):
    • Add State/In Review
    • Add Type/Documentation
    • Add Priority/Medium
  3. Consider assigning to a reviewer for peer review

Automated by CleverAgents Bot
Supervisor: Grooming | Agent: grooming-pool-supervisor

[GROOMED] Quality Analysis Complete ## Analysis Summary ### Current Status - **PR**: #10340 "[AUTO-DOCS-1] Fix documentation nav, broken anchors, and missing showcase page" - **Created**: 2026-04-18 (today) - **State**: Open - **Changes**: 293 additions, 6 deletions across 3 files ### Issues Found & Fixed #### ✅ Milestone Assignment - **Status**: FIXED - **Action**: Assigned to milestone `v3.9.0` (documentation and feature updates) - **Reason**: This PR contains pure documentation improvements #### ⚠️ Labels (Attempted) - **Status**: BLOCKED - Label API endpoints are restricted - **Required Labels**: - `State/In Review` (id: 844) - PR awaiting peer review - `Type/Documentation` (id: 852) - Documentation improvement - `Priority/Medium` (id: 860) - Standard priority for docs - **Note**: Label endpoints are blocked by system permissions. Manual label assignment may be required. #### ✅ PR Content Validation - **Description**: Well-structured with clear summary of changes - **Changes**: 1. Fixed mkdocs.yml navigation (added complete Showcase section) 2. Created missing showcase page for config-and-automation-profiles 3. Fixed 12 broken internal anchor links in specification.md - **Quality**: High - specific, detailed, and well-documented #### ✅ Review Status - **Reviewers**: None assigned (expected for new PR) - **Comments**: None yet (expected for new PR) - **Mergeable**: Yes ### Recommendations 1. ✅ Milestone assigned to v3.9.0 2. ⚠️ Labels need manual assignment (API blocked): - Add `State/In Review` - Add `Type/Documentation` - Add `Priority/Medium` 3. Consider assigning to a reviewer for peer review --- **Automated by CleverAgents Bot** Supervisor: Grooming | Agent: grooming-pool-supervisor
Author
Owner

Update: Label Assignment Status

Type/Documentation label has been successfully applied.

⚠️ Remaining labels blocked by API restrictions:

  • State/In Review (id: 844) - requires manual assignment
  • Priority/Medium (id: 860) - requires manual assignment

The label API endpoints are restricted and cannot be accessed programmatically. These labels will need to be added manually through the Forgejo UI.

Current PR Status:

  • Milestone: v3.9.0 (assigned)
  • Type/Documentation label (assigned)
  • ⚠️ State/In Review label (needs manual assignment)
  • ⚠️ Priority/Medium label (needs manual assignment)
## Update: Label Assignment Status ✅ **Type/Documentation** label has been successfully applied. ⚠️ **Remaining labels blocked by API restrictions:** - `State/In Review` (id: 844) - requires manual assignment - `Priority/Medium` (id: 860) - requires manual assignment The label API endpoints are restricted and cannot be accessed programmatically. These labels will need to be added manually through the Forgejo UI. **Current PR Status:** - ✅ Milestone: v3.9.0 (assigned) - ✅ Type/Documentation label (assigned) - ⚠️ State/In Review label (needs manual assignment) - ⚠️ Priority/Medium label (needs manual assignment)
freemo closed this pull request 2026-04-19 18:02:46 +00:00

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core!10340
No description provided.