Skip to content

docs: ferrus 0.5.0-alpha.1 and the Nano executor - #28

Merged
RomanEmreis merged 1 commit into
mainfrom
docs/ferrus-0.5.0-nano
Oct 5, 2026
Merged

RomanEmreis merged 1 commit into
mainfrom
docs/ferrus-0.5.0-nano

Conversation

@RomanEmreis

Copy link
Copy Markdown
Collaborator

Summary

ferrus 0.5.0-alpha.1 ships Nano, the native agent harness. It runs headless and only as the Executor. This PR documents the release and adds a short page on what Nano can do today.

New page: docs/nano.md

  • What Nano is, plus a caution block on its status: headless Executor only, so pair it with an external supervisor.
  • Install: release archives already include Nano, while cargo install needs --features nano-openai,nano-mcp.
  • LM Studio setup with ferrus register --executor nano --executor-model …, the generated ~/.ferrus/nano.toml, and FERRUS_NANO_CONFIG.
  • A table of provider settings.
  • What Nano can do today:
    • workspace tools with digest-checked patches;
    • bounded background commands;
    • native check, submit, consult, and ask_human;
    • repository graph and project memory tools, plus the working set;
    • context budgeting and compaction;
    • crash recovery with effect reconciliation;
    • opt-in stdio MCP tools.
  • How HQ runs Nano, the failure codes (nano_provider_*, nano_limit_*), current limitations, and links to the in-repo design notes.
  • Added to the sidebar after "Supported agents" and to the footer.

Updated pages

  • agents: a Nano row in the backends table, a Nano subsection, and a note that Nano can only be the Executor.
  • quickstart: nano in the agent list, and a note that cargo install leaves Nano out by default.
  • configuration: nano as a valid [hq.executor] agent, and where its provider settings live.
  • hq: /executor isn't available when the executor is Nano.
  • local-models: Nano listed as a local-model option. Two Nano-specific notes:
    • nano.toml accepts only temperature from the sampling table;
    • Nano defaults to reasoning_effort = "none".
  • Landing page:
    • badge bumped to v0.5.0 and the version pin to 0.5.0-alpha.1;
    • a crates.io install line with the Nano features;
    • Nano added to the "Agent-agnostic" card;
    • a short "New in 0.5: Nano" section.

Notes for reviewers

  • Sources: the ferrus 0.5.0-alpha.1 tag (its docs/ferrus-nano-*.md, src/nano/config.rs, and src/cli), not the in-progress interactive-mode branch. The config keys and defaults were checked against src/nano/config.rs at the tag.
  • The landing-page Nano section wasn't strictly required. To keep section backgrounds alternating, it flips the backgrounds of "Repository graph" (now alt) and "Why ferrus" (now plain). It's easy to drop if you'd rather keep the landing page as it was.
  • The admonitions use the :::caution[Title] syntax. The :::note Title form rendered as raw text on this Docusaurus version.

Test plan

  • npx tsc --noEmit passes
  • npm run build succeeds with no broken links or anchors
  • Checked /docs/nano, /docs/local-models, and the landing page in a local docusaurus serve

🤖 Generated with Claude Code

Add a Nano page covering installation, LM Studio setup, provider
settings, what the headless Executor can do today, how HQ runs it,
and current limitations. Mention Nano across the agents, quickstart,
configuration, HQ, and local-models pages, and bump the landing page
to v0.5.0 with a short Nano section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@RomanEmreis RomanEmreis self-assigned this Oct 5, 2026
@RomanEmreis RomanEmreis added the documentation Improvements or additions to documentation label Oct 5, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown
Contributor

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
ferrus 0b68f9c Commit Preview URL

Branch Preview URL
Oct 05 2026, 03:58 PM

@RomanEmreis
RomanEmreis merged commit e7ca2d9 into main Oct 5, 2026
2 checks passed
@RomanEmreis
RomanEmreis deleted the docs/ferrus-0.5.0-nano branch October 5, 2026 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant