Skip to content

docs: clarify agent archive exploration guidance#64

Merged
Moskize91 merged 2 commits into
mainfrom
docs/scoped-agent-exploration
Jun 17, 2026
Merged

docs: clarify agent archive exploration guidance#64
Moskize91 merged 2 commits into
mainfrom
docs/scoped-agent-exploration

Conversation

@Moskize91

Copy link
Copy Markdown
Contributor

Summary

  • clarify that agent content exploration should start from chapter tree and then use scoped list/page calls
  • describe when index is useful for archive-level readiness and metadata
  • document page fragment: as the better source-evidence entry point for logic-chain and relationship analysis

Checks

  • pnpm run lint:fix

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4ce41fa0-7d93-420e-8623-8f6cbb9b15b2

📥 Commits

Reviewing files that changed from the base of the PR and between db67992 and 8f0c1ac.

📒 Files selected for processing (6)
  • data/help/commands/archive/index.jinja
  • data/help/commands/archive/read.jinja
  • data/help/topics/ai.jinja
  • data/help/topics/overview.jinja
  • docs/en/ai-agents.md
  • docs/zh-CN/ai-agents.md

Summary by CodeRabbit

  • Documentation
    • Refreshed help and guide documentation with improved command workflow recommendations and clearer usage guidance
    • Enhanced exploration strategies with detailed recommended command sequences for different discovery and analysis tasks
    • Added explicit guidance on optimal command usage patterns for structure mapping, keyword discovery, and content reading

Walkthrough

Documentation-only update across Jinja help templates and Markdown AI-agent guides. The index.jinja command help gains two lines about archive-level readiness and follow-up list --chapter usage. The read.jinja help clarifies page fragment:<id> for evidence tracing versus read for immersive prose. The ai.jinja and overview.jinja topic guides replace the older list --type chapter / unscoped index-first flow with a chapter tree --json → scoped list --chapter <ids>page chapter:<id>page fragment:<id> sequence. Both docs/en/ai-agents.md and docs/zh-CN/ai-agents.md receive matching updates to example command blocks and an expanded numbered execution strategy.

Possibly related PRs

  • oomol-lab/spinedigest#10: Introduced docs/en/ai-agents.md; this PR updates the same file's command examples and execution strategy section.
  • oomol-lab/spinedigest#37: Introduced the layered CLI help system that renders the data/help/ Jinja templates updated in this PR.
  • oomol-lab/spinedigest#57: Added the archive command help files (data/help/commands/archive/index.jinja, read.jinja) and topic files (ai.jinja, overview.jinja) that are revised in this PR.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format docs: clarify agent archive exploration guidance with proper type and subject, clearly summarizing the main documentation updates about agent archive exploration.
Description check ✅ Passed The description is directly related to the changeset, explaining the key improvements made across multiple documentation files regarding agent content exploration workflows.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/scoped-agent-exploration

Comment @coderabbitai help to get the list of available commands and usage tips.

@Moskize91 Moskize91 merged commit 4f34044 into main Jun 17, 2026
3 checks passed
@Moskize91 Moskize91 deleted the docs/scoped-agent-exploration branch June 17, 2026 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant