Skip to content

docs: comprehensive refresh of README, docs-site, and marketing site - #373

Merged
getappz merged 2 commits into
masterfrom
task/406
Jul 29, 2026
Merged

getappz merged 2 commits into
masterfrom
task/406

Conversation

@getappz

@getappz getappz commented Jul 29, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Retires stale Caveman/Ponytail branding — they're now agentflare optimize output/agentflare optimize code, built into the binary rather than separate companion plugins
  • Documents the full feature set shipped since the docs last caught up: daemon, agentflare work, vent, serve dashboard, global search (17 sources), flare-proxy, git-aware branch guard, auth vault, skill registry, and more
  • Expands docs-site/ from a single-feature site (only flare-docs) into a full product reference: overview, getting started, concepts, CLI reference (30 commands), MCP tools reference (24 tools), guides, comparisons — flare-docs demoted to one feature page among many
  • Updates site/public/index.html marketing copy to reflect the current capability set
  • Fixes a real MIT/Apache-2.0 license mismatch (README/CONTRIBUTING said MIT; LICENSE/Cargo.toml say Apache-2.0)
  • Fixes a false claim in AGENTS.md that agentflare caveman/agentflare ponytail still work as CLI aliases (only flare/opt do)
  • Fixes stale claims in STATUS.md (no-daemon, Caveman/Ponytail wiring)

Driven by a full feature census (CLI surface, MCP tool surface, component registry, changelog, workspace crates) read directly from source, not memory — every command/tool/flag named in the new docs was verified against src/.

Design spec: item #406.

Test plan

  • docs-site builds cleanly (astro build — 9 pages generated, no broken links/frontmatter errors)
  • Swept for remaining stale Caveman/Ponytail references and broken /docs/* cross-links after merging all changes
  • Visual check of the deployed docs site / landing page after merge

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation around Agentflare’s optimization vs. coordination axes, with new concepts, getting-started guidance, and expanded CLI + MCP tool references.
    • Added coverage for coordination workflows (claims, reviews, artifacts, handoffs, work loop) and current package documentation via flare-docs.
    • Updated status details (optimize output/code now built-in and stable), clarified legacy alias/cleanup behavior, revised architecture/install/uninstall guidance, refreshed metrics and verification examples, and updated licensing text.
    • Removed outdated “Examples” and “How it works” content; rewrote comparison/landing pages.
  • Website
    • Refreshed homepage messaging, layers navigation, metrics, and install/feature copy to match the new product terminology and supported integrations.

Retires stale Caveman/Ponytail branding (now agentflare optimize output/code,
built into the binary rather than separate companion plugins) and documents
the full feature set shipped since — daemon, agentflare work, vent, serve
dashboard, global search, flare-proxy, git-aware branch guard, auth vault,
skill registry, and more.

- README.md / CONTRIBUTING.md: accurate feature tables, regenerated
  Architecture section against the real src/ tree, corrected MIT->Apache-2.0
  license mismatch
- AGENTS.md: fixed false claim that caveman/ponytail still work as CLI aliases
- STATUS.md: fixed stale no-daemon claim and Caveman/Ponytail wiring line
- docs-site/: expanded from a single-feature (flare-docs) site into a full
  product reference - overview, getting started, concepts, CLI reference,
  MCP tools reference, guides, comparisons, with flare-docs demoted to one
  feature page among many
- site/public/index.html: landing page copy pass to reflect the current
  capability set
@coderabbitai

coderabbitai Bot commented Jul 29, 2026 •

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fc6c0a-2c69-4ef4-aa68-a9ab62c33e1b

📥 Commits

Reviewing files that changed from the base of the PR and between 95eefed and 7d7e6fa.

📒 Files selected for processing (7)
  • README.md
  • docs-site/src/content/docs/compare.md
  • docs-site/src/content/docs/flare-docs.md
  • docs-site/src/content/docs/getting-started.md
  • docs-site/src/content/docs/guides.md
  • docs-site/src/content/docs/mcp-tools.md
  • site/public/index.html
🚧 Files skipped from review as they are similar to previous changes (7)
  • docs-site/src/content/docs/flare-docs.md
  • docs-site/src/content/docs/getting-started.md
  • docs-site/src/content/docs/mcp-tools.md
  • docs-site/src/content/docs/guides.md
  • docs-site/src/content/docs/compare.md
  • README.md
  • site/public/index.html

📝 Walkthrough

Walkthrough

Documentation and product-facing copy now describe built-in optimization, multi-agent coordination, expanded CLI/MCP surfaces, updated installation workflows, refreshed flare-docs guidance, and Apache License 2.0 terms.

Changes

Product model and repository documentation

Layer / File(s) Summary
Product model and repository documentation
AGENTS.md, CONTRIBUTING.md, README.md, STATUS.md
Updates optimization aliases, architecture listings, licensing references, stability notes, daemon status, uninstall behavior, and built-in optimization terminology.

Documentation information architecture

Layer / File(s) Summary
Documentation information architecture
docs-site/astro.config.mjs, docs-site/src/content/docs/{index.mdx,concepts.md,compare.md}
Reorganizes navigation and reframes the documentation around optimization, coordination, concepts, comparisons, and related references.

Installation and workflows

Layer / File(s) Summary
Installation and agent workflows
docs-site/src/content/docs/{getting-started.md,guides.md}
Adds installation and agent-wiring instructions plus workflows for documentation lookup, work claiming, artifacts, and review consensus.

Command and MCP reference

Layer / File(s) Summary
Command and MCP reference
docs-site/src/content/docs/{cli.md,mcp-tools.md}
Expands CLI coverage and documents coordination, knowledge, optimization, Git, utility, and slash-command MCP tools.

Flare-docs reference

Layer / File(s) Summary
Flare-docs reference
docs-site/src/content/docs/flare-docs.md
Documents supported ecosystems, package-name inference, MCP actions, caching, and extracted package examples.

Landing-page product copy

Layer / File(s) Summary
Landing-page product copy
site/public/index.html
Updates branding, metrics, optimization and coordination descriptions, supported integrations, navigation, daemon wording, and terminal examples.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main scope: a documentation refresh across README, docs-site, and marketing pages.
Description check ✅ Passed The description covers Summary and Test plan well; it only omits the Notes for reviewers section from the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch task/406

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs-site/src/content/docs/cli.md (1)

18-579: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add language identifiers to all affected documentation fences.

The same MD040 issue appears across the documentation pages:

  • docs-site/src/content/docs/cli.md#L18-L579: label shell, JSON, text, and other fenced examples appropriately.
  • docs-site/src/content/docs/guides.md#L74-L103: label the three unlabelled workflow examples.
  • docs-site/src/content/docs/mcp-tools.md#L25-L285: label the tool-call examples.
  • docs-site/src/content/docs/flare-docs.md#L46-L46: label the raw error example as text.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs-site/src/content/docs/cli.md` around lines 18 - 579, Label every
affected documentation code fence with an appropriate language identifier to
resolve MD040: update shell, JSON, text, and other examples in
docs-site/src/content/docs/cli.md lines 18-579; label the three workflow
examples in docs-site/src/content/docs/guides.md lines 74-103; label tool-call
examples in docs-site/src/content/docs/mcp-tools.md lines 25-285; and mark the
raw error example as text in docs-site/src/content/docs/flare-docs.md line 46.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs-site/src/content/docs/compare.md`:
- Around line 19-25: Update the command references in the comparison text to use
the canonical `agentflare optimize output` and `agentflare optimize code`
spellings, replacing any bare optimize subcommands. Preserve the surrounding
explanation and clarify that `flare` and `opt` are backward-compatible aliases
while `caveman` and `ponytail` are not live aliases.

In `@docs-site/src/content/docs/getting-started.md`:
- Around line 22-23: Update the getting-started documentation around the
`agentflare init --agent <host>` example to reflect that initialization prompts
for confirmation by default. Either state that `-y`/`--yes` skips the prompt or
include that flag in the command example, while preserving the
one-command-per-tool guidance.

In `@README.md`:
- Around line 123-128: Update the fenced code block containing the lean-ctx,
optimize output, optimize code, and memory metrics with an appropriate language
tag such as text or console, without changing its contents.
- Around line 61-80: Update the paragraph immediately following the coordination
table to remove the stale “no daemon” claim and the implication that all
functionality is accessed through stdio MCP. Clearly distinguish the opt-in
daemon and dashboard paths from the MCP transport, while preserving the
surrounding architecture description.

In `@site/public/index.html`:
- Around line 430-433: Update the claim text in the table row for the optimize
code result to remove the unsupported “100% safe” wording; replace it with the
exact safety outcome verified by the methodology, or omit the safety claim
entirely while preserving the other metrics.

---

Outside diff comments:
In `@docs-site/src/content/docs/cli.md`:
- Around line 18-579: Label every affected documentation code fence with an
appropriate language identifier to resolve MD040: update shell, JSON, text, and
other examples in docs-site/src/content/docs/cli.md lines 18-579; label the
three workflow examples in docs-site/src/content/docs/guides.md lines 74-103;
label tool-call examples in docs-site/src/content/docs/mcp-tools.md lines
25-285; and mark the raw error example as text in
docs-site/src/content/docs/flare-docs.md line 46.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3d9e8b47-ff8a-4551-a87c-f15f7388e908

📥 Commits

Reviewing files that changed from the base of the PR and between 4d49fa6 and 95eefed.

📒 Files selected for processing (17)
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • STATUS.md
  • docs-site/astro.config.mjs
  • docs-site/src/content/docs/cli.md
  • docs-site/src/content/docs/compare.md
  • docs-site/src/content/docs/concepts.md
  • docs-site/src/content/docs/examples.md
  • docs-site/src/content/docs/flare-docs.md
  • docs-site/src/content/docs/getting-started.md
  • docs-site/src/content/docs/guides.md
  • docs-site/src/content/docs/how-it-works.md
  • docs-site/src/content/docs/index.mdx
  • docs-site/src/content/docs/mcp-tool.md
  • docs-site/src/content/docs/mcp-tools.md
  • site/public/index.html
💤 Files with no reviewable changes (3)
  • docs-site/src/content/docs/mcp-tool.md
  • docs-site/src/content/docs/how-it-works.md
  • docs-site/src/content/docs/examples.md

Comment thread docs-site/src/content/docs/compare.md
Comment thread docs-site/src/content/docs/getting-started.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread site/public/index.html
- compare.md: use canonical agentflare optimize output/code spellings, note flare/opt aliases vs caveman/ponytail
- getting-started.md: clarify -y/--yes skips secondary init prompts
- README.md: correct no-daemon claim, distinguish opt-in daemon/dashboard from MCP transport; label real-usage code fence
- site/public/index.html: drop unsupported 100% safe claim, state measured outcome
- mcp-tools.md, guides.md, flare-docs.md: label MD040-flagged code fences
@getappz
getappz merged commit 9a8dd89 into master Jul 29, 2026
16 checks passed
@getappz
getappz deleted the task/406 branch July 29, 2026 13:51
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