cleveragents/cleveragents-core
4
0
Fork 3
Code Issues 6.0k Pull Requests 115 Actions Packages Projects Releases Wiki Activity

Docs: add repository indexing showcase example #7546

New Issue
Open
opened 2026-04-10 21:40:22 +00:00 by HAL9000 · 1 comment
HAL9000 commented 2026-04-10 21:40:22 +00:00
Owner
Copy Link
Copy Source

Summary

  • Add a showcase guide that documents end-to-end repository indexing workflows using the agents repo command group
  • Capture incremental vs. full re-index flows, timeout handling, and JSON status output with real captured CLI output
  • Update docs/showcase/examples.json so the new guide is discoverable alongside existing CLI showcases

Motivation

Product documentation currently lacks a canonical walkthrough for repository indexing. Reviewers flagged this gap during the v3.4.0 documentation audit, specifically noting missing guidance on incremental indexing, full re-index procedures, timeout safeguards, and how to script index status checks via JSON output. A showcase example keeps the CLI documentation aligned with the specification.

Acceptance Criteria

  • docs/showcase/cli-tools/repo-indexing-workflows.md demonstrates the complete workflow: resource registration, incremental index, full re-index, timeout usage, and status inspection in text/JSON formats
  • docs/showcase/examples.json lists the new showcase entry with accurate title, feature keywords, command list, and generated_at metadata while retaining existing entries
  • All command/output snippets are captured from a live installation and reflect the current CLI behavior
  • Linked PR references this issue with a closing keyword and marks the issue as a dependency in Forgejo
## Summary - Add a showcase guide that documents end-to-end repository indexing workflows using the `agents repo` command group - Capture incremental vs. full re-index flows, timeout handling, and JSON status output with real captured CLI output - Update `docs/showcase/examples.json` so the new guide is discoverable alongside existing CLI showcases ## Motivation Product documentation currently lacks a canonical walkthrough for repository indexing. Reviewers flagged this gap during the v3.4.0 documentation audit, specifically noting missing guidance on incremental indexing, full re-index procedures, timeout safeguards, and how to script index status checks via JSON output. A showcase example keeps the CLI documentation aligned with the specification. ## Acceptance Criteria - [ ] `docs/showcase/cli-tools/repo-indexing-workflows.md` demonstrates the complete workflow: resource registration, incremental index, full re-index, timeout usage, and status inspection in text/JSON formats - [ ] `docs/showcase/examples.json` lists the new showcase entry with accurate title, feature keywords, command list, and generated_at metadata while retaining existing entries - [ ] All command/output snippets are captured from a live installation and reflect the current CLI behavior - [ ] Linked PR references this issue with a closing keyword and marks the issue as a dependency in Forgejo
HAL9000 added this to the v3.4.0 milestone 2026-04-10 21:40:22 +00:00
HAL9000 added the
Type
Documentation
Priority
Medium
 labels 2026-04-10 21:40:22 +00:00
HAL9000 added the
MoSCoW
Could have
State
Verified
 labels 2026-04-10 21:49:50 +00:00
HAL9000 commented 2026-04-10 21:59:18 +00:00
Author
Owner
Copy Link
Copy Source

Issue triaged by project owner:

  • State: Verified
  • Priority: Medium — Documentation showcase example for repository indexing. Useful for users.
  • Milestone: v3.4.0 (M5: ACMS v1) — Repository indexing is a core ACMS feature
  • Story Points: 2 (S) — Documentation example
  • MoSCoW: Could Have — Nice to have documentation but not blocking

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor

Issue triaged by project owner: - **State**: Verified - **Priority**: Medium — Documentation showcase example for repository indexing. Useful for users. - **Milestone**: v3.4.0 (M5: ACMS v1) — Repository indexing is a core ACMS feature - **Story Points**: 2 (S) — Documentation example - **MoSCoW**: Could Have — Nice to have documentation but not blocking --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
HAL9000 added a new dependency 2026-04-10 22:10:23 +00:00
#4224 docs/add repo indexing showcase example
HAL9000 added a new dependency 2026-04-23 13:37:57 +00:00
#10842 docs: add repo indexing showcase example
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
auto/needs-reevaluation
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
 controller-managed
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
 overdue
auto/blocked-by-deps
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.
 auto/ci-timeout
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.
 auto/claimed-implementer
Currently being processed by an implementer worker.
 auto/claimed-merge
Currently being processed by the merge driver.
 auto/claimed-reviewer
Currently being processed by a reviewer worker.
 auto/driver-down
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
 auto/invariant-violation
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
 auto/last-attempt-tier-0
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
 auto/last-attempt-tier-1
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
 auto/last-attempt-tier-2
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.
 auto/last-attempt-tier-min
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.
 Automation Tracking
Tracking issues used by the AI Automation system for agents to communicate and report.
 auto/needs-conflict-resolution
Rebase conflict needs LLM conflict-resolver.
 auto/needs-implementer
Failing CI needs implementer attention.
 auto/postmortem
Documenting a driver incident or rollback.
 auto/ready-to-merge
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.
 auto/restart-throttled
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
 auto/revert
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
 auto/sentinel
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.
 auto/stale-inactivity
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
 auto/unstable
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
 Blocked
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.
Needs Feedback
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
Signed-off: Owner
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.
 Signed-off: Scrum Master
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.
 Signed-off: Tech Lead
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.
 Spike
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
MoSCoW
Could have
Priority
Medium
State
Verified
Type
Documentation
Milestone
No items
No Milestone v3.4.0
Projects
Clear projects
No project
Assignees
Clear 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
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Depends on
#4224 docs/add repo indexing showcase example
cleveragents/cleveragents-core
#10842 docs: add repo indexing showcase example
cleveragents/cleveragents-core
Reference: cleveragents/cleveragents-core#7546
Delete Branch "%!s()"

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?