Skip to content

docs: rewrite README with providers, model tiers, and API key instructions#659

Merged
FL4TLiN3 merged 1 commit intomainfrom
docs/rewrite-readme-providers-and-model-tiers
Feb 28, 2026
Merged

docs: rewrite README with providers, model tiers, and API key instructions#659
FL4TLiN3 merged 1 commit intomainfrom
docs/rewrite-readme-providers-and-model-tiers

Conversation

@FL4TLiN3
Copy link
Contributor

Summary

  • Rewrites README intro with core philosophies and getting started flow
  • Adds providers section with choosing a provider (CLI flags > perstack.toml > defaults resolution order)
  • Adds model tiers section explaining defaultModelTier auto-selection across providers
  • Adds API key instructions: host env vars with -e and workspace .env file
  • Adds how-it-works stack model overview
  • Links prerequisites to providers section instead of external docs
  • Updates going-to-production, concept, and sandbox-integration docs to use consistent terminology

Test plan

  • Verify all internal links resolve correctly
  • Confirm model tier table matches packages/core/src/known-models/index.ts
  • Review README rendering on GitHub

🤖 Generated with Claude Code

…tions

- Rewrite README intro with core philosophies and getting started flow
- Add providers section with choosing a provider and resolution order
- Add model tiers section explaining defaultModelTier auto-selection
- Add API key instructions (host env vars with -e and workspace .env)
- Add how-it-works stack model overview
- Link prerequisites to providers section instead of external docs
- Update going-to-production, concept, and sandbox-integration docs
  to use consistent terminology (sandbox-first → container isolation)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@FL4TLiN3 FL4TLiN3 enabled auto-merge (squash) February 28, 2026 08:27
@FL4TLiN3 FL4TLiN3 merged commit 8c216fe into main Feb 28, 2026
11 checks passed
@FL4TLiN3 FL4TLiN3 deleted the docs/rewrite-readme-providers-and-model-tiers branch February 28, 2026 08:28
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