Skip to content

docs: revamp README and add Fireworks provider docs#729

Merged
FL4TLiN3 merged 1 commit intomainfrom
docs/revamp-readme-for-hn
Mar 7, 2026
Merged

docs: revamp README and add Fireworks provider docs#729
FL4TLiN3 merged 1 commit intomainfrom
docs/revamp-readme-for-hn

Conversation

@FL4TLiN3
Copy link
Contributor

@FL4TLiN3 FL4TLiN3 commented Mar 7, 2026

Summary

  • Restructure README with clearer Getting Started flow: define → run → integrate → deploy → why micro-agents
  • Position Fireworks as the reference provider across all examples (Getting Started, API keys, Deployment)
  • Add "Why micro-agents?" section (reusable, cost-effective, fast, maintainable)
  • Add "Integrating with your app" section with harness/app separation diagram
  • Add Fireworks section to docs/references/providers-and-models.md (env vars, toml settings, model list)
  • Fix broken #providers anchor link → docs site URL
  • Add demo cost info ($0.10) and npx playable command

Test plan

  • Verify all links resolve (providers-and-models, deployment guide, react docs)
  • Confirm README renders correctly on GitHub
  • Check Fireworks provider docs match actual implementation

🤖 Generated with Claude Code

- Restructure README with clearer Getting Started flow (define, run, integrate, deploy)
- Position Fireworks as the reference provider in all examples
- Add "Why micro-agents?" section explaining reusability, cost, speed, and maintainability
- Add "Integrating with your app" section with architecture diagram
- Add Fireworks section to providers-and-models documentation
- Fix broken #providers anchor link
- Add demo cost info and npx command

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@FL4TLiN3 FL4TLiN3 merged commit 0a891e4 into main Mar 7, 2026
11 checks passed
@FL4TLiN3 FL4TLiN3 deleted the docs/revamp-readme-for-hn branch March 7, 2026 22: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