Skip to content

docs: simplify navigation and first fleet setup - #226

Merged
indykish merged 1 commit into
mainfrom
chore/minimal-docs-navigation
Oct 24, 2026
Merged

indykish merged 1 commit into
mainfrom
chore/minimal-docs-navigation

Conversation

@indykish

@indykish indykish commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Start with a short dashboard task, then connect apps as needed. Guides, command-line reference, API reference, and runner operations have separate tabs.

The previous GitHub walkthrough and all 140 API operations remain available. Companion to agentsfleet/agentsfleet#784.

Documentation

Status: updated. Corrected billing name/callsign wording; no blockers.

Audited the ten selected files and relevant linked docs against the approved product source. Existing navigation targets and all 140 API operations remain.

Documentation health:
README.md [Current] (Orly 0.17.0 matches the pin)
index.mdx [Current] (concise entry point)
concepts.mdx [Current] (fleet explanation)
quickstart.mdx [Current] (dashboard task; saving and running distinguished)
cli/agentsfleet.mdx [Current] (manual sign-in)
cli/configuration.mdx [Current] (manual sign-in)
fleets/overview.mdx [Updated] (billing name and callsign fallback)
tutorials/github-pr-reviewer.mdx [Current] (previous walkthrough retained)
docs.json [Current] (all targets retained)
changelog.mdx [Current] (new claims checked; history preserved)

Coverage debt: none introduced; tutorial, how-to, reference and explanation remain available. Diagram drift: none. Static documentation and whitespace checks passed; parent owns final checks.

Session notes 1

Simplified the entry pages and navigation using Puffle's task-first structure. Updated manual terminal sign-in guidance and corrected fleet names in billing and runner history.
The API prose cleanup is being delivered in the product repository. An Astra review of both is pending.

Review

No remaining findings from source, coverage, adversarial, and documentation reviews. No new application paths or tests. Gate edits: none detected (zero listed or eligible hunks). Outside review is disabled.
Local browser checks confirmed the quickstart and retained tutorial navigation; the quickstart rendered at 375 pixels without page overflow. Authenticated first-fleet creation was not exercised.
Screenshot: /private/tmp/minimal-docs-qa/screenshots/quickstart-mobile.png; measured page width and body width were both 375 pixels.

Make

Local verification:

  • make test: exit 0, 25 tests passed; documentation check passed.
  • bun run orly gate pr: exit 0; clean, pushed branch; language, build, OpenAPI navigation, and link checks passed.
  • gitleaks dir . --redact --no-banner --config .gitleaks.toml: exit 0, no leaks found.
  • orly-babysit-prs: pending after creation; local checks are not a green remote pipeline.

RetriggerView in GreptileConfidence Score: 5/5

The PR appears safe to merge; no actionable issue was found.

Summary

Replaces the terminal-based quickstart with a short dashboard task and keeps the GitHub walkthrough as a separate tutorial.

  • The first-fleet guide starts with a dashboard task.
  • Guides and reference pages have separate navigation paths.
  • Terminal sign-in instructions show where browser approval finishes.
  • Fleet pages distinguish chosen names from runner callsigns.
  • The changelog and README describe the current docs release.

Reviews (1) · Last reviewed commit: "docs: simplify navigation and first flee..." · Reviewed by Greptile

@indykish
indykish merged commit 017c77c into main Oct 24, 2026
4 checks passed
@indykish
indykish deleted the chore/minimal-docs-navigation branch October 24, 2026 05:45
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