Welcome
Project documentation home
Welcome to Your Project¶
This is your project's documentation home. Edit this file to introduce your project.
Getting Started¶
Add your project-specific documentation here. Common pages to create:
- User Guide - How to use your application
- API Reference - Developer documentation
- FAQ - Common questions and answers
Documentation Structure¶
Your docs live in apps/help/content/. The structure is:
apps/help/content/
├── _config.yaml # Your doc configuration
├── index.md # This welcome page
└── smallstack/ # SmallStack reference docs
Adding New Pages¶
- Create a
.mdfile in this folder - Add it to
_config.yamlunder your section's pages - It will appear at
/help/your-page-slug/
See Using the Help System for detailed instructions.
Quick Links¶
Your Project¶
- Edit
templates/website/home.htmlfor your homepage - Edit
.envto setSITE_NAMEandSITE_DOMAIN - Add pages in
apps/website/for landing pages, about, etc.
SmallStack Reference¶
- Getting Started - Quick setup guide
- Customization Guide - Make it your own
- Deployment - Deploy to production