Easy Starter Docs

Simple, practical documentation for choosing, using, extending, and maintaining Easy Starter templates.

فارسی · Documentation · Report an issue

“What do we build for, if not to lessen each other’s hardship?”

What it solves

Provides one clear learning path for developers, freelancers, solopreneurs, and non-technical builders using the Easy Starter ecosystem.

Use this template for

• Choosing the correct starter
• Starting and configuring a project
• Writing specs for coding agents
• Reviewing AI-generated code
• Testing, deployment, security, and upgrades

Not intended for: Framework API reference; official framework documentation remains the source of truth.

Baseline

• Task-oriented guides
• Conceptual AI-first development guidance
• Starter selection matrix
• Production-readiness checklists
• English and Persian content structure

Detailed architecture, conventions, deployment profiles, and extension guides belong in docs/. Feature work starts from specs/, and agent rules live in AGENTS.md.

Quick start

1. Create a repository from this template.
2. Replace organization links and site metadata.
3. Install dependencies with pnpm install.
4. Run the documentation site with pnpm dev.
5. Add or update a guide in the appropriate section and run pnpm check.

Working agreement

• Read AGENTS.md and the relevant specification before changing code.
• Reuse existing patterns before adding abstractions or dependencies.
• Never commit credentials or production data.
• Run the repository quality checks before opening a pull request.
• Record architecture-changing decisions in docs/decisions/.

Documentation

Start with docs/getting-started.md. Broader AI-first development guidance is maintained in Easy Starter Docs.

Contributing and support

See CONTRIBUTING.md for contribution rules and SUPPORT.md for help. Security issues must follow SECURITY.md.

License

Released under the MIT License.