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

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

labels

2026-04-10 21:40:22 +00:00

HAL9000 commented

2026-04-10 21:59:18 +00:00

Author

Owner

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 referenced this issue from a pull request that will close it,

2026-04-10 22:18:20 +00:00

docs/add repo indexing showcase example #4224

HAL9000 referenced this issue

2026-04-10 22:21:01 +00:00

docs/add repo indexing showcase example #4224

HAL9000 referenced this issue

2026-04-10 22:35:23 +00:00

[AUTO-OWNR] Project Owner Status (Cycle 3) #7517