Summary
Build a documentation website for Polira (to be rebranded as Ktavi) hosted at ktavi.ai and ktavi.com. The site should serve as the primary documentation hub, marketing landing page, and developer reference.
Scope
Landing page (ktavi.com / ktavi.ai)
- Product overview and value proposition
- Feature highlights with examples
- Installation quickstart
- Pricing/plans (if applicable)
- Links to documentation, GitHub, and community
Documentation site
- Getting started: installation, first run, config setup
- CLI reference: all commands with flags, options, and examples
- Configuration guide: config file format, precedence rules, all options explained
- Provider setup: OpenAI API key, Cloudinary credentials, future providers
- Workflows: how analyze, review, fix, seo, cover, and prepare work together
- Architecture: four-layer design, extending with custom providers
- API reference: auto-generated from TypeScript types (for programmatic usage)
- Changelog: powered by changesets
Interactive features
- Live playground / demo (optional): paste Markdown, see analysis output
- Config builder: interactive form that generates a
polira.config.ts
- Search across all documentation
Tech stack considerations
| Option |
Pros |
Cons |
| Astro + Starlight |
Built for docs, fast, MDX support, search built-in |
Less flexibility for custom interactive pages |
| Next.js |
Full flexibility, React ecosystem, API routes for playground |
Heavier for pure docs |
| VitePress |
Vue-based, fast, good docs theme |
Less React ecosystem alignment |
| Nuxt Content |
Vue-based, good content management |
Different ecosystem |
Recommendation: Astro + Starlight for documentation (lightweight, purpose-built), with optional interactive pages using React islands for playground/config builder.
Task list
Notes
- Documentation content should be written as the CLI features stabilize
- Consider keeping docs in the main repo (
docs/) or a separate ktavi-docs repo
- The site should reflect the Ktavi rebrand (name, logo, colors)
- The web app code should not be bundled together with the source code of the CLI
Summary
Build a documentation website for Polira (to be rebranded as Ktavi) hosted at ktavi.ai and ktavi.com. The site should serve as the primary documentation hub, marketing landing page, and developer reference.
Scope
Landing page (ktavi.com / ktavi.ai)
Documentation site
Interactive features
polira.config.tsTech stack considerations
Recommendation: Astro + Starlight for documentation (lightweight, purpose-built), with optional interactive pages using React islands for playground/config builder.
Task list
Notes
docs/) or a separatektavi-docsrepo