Skip to content

Commit 58b4d00

Browse files
committed
[DOCS] add guide docs contents
1 parent 48b886b commit 58b4d00

File tree

15 files changed

+6785
-4
lines changed

15 files changed

+6785
-4
lines changed

docs/contributing/code-guidelines.md

Lines changed: 702 additions & 0 deletions
Large diffs are not rendered by default.

docs/contributing/development-setup.md

Lines changed: 768 additions & 0 deletions
Large diffs are not rendered by default.

docs/index.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,35 @@ This idea was initiated with the aim of full fill to help FastAPI newcomers to l
267267

268268
As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
269269

270+
## Next Steps
271+
272+
Ready to get started with FastAPI-fastkit? Follow these next steps:
273+
274+
### 🚀 Quick Start
275+
276+
1. **[Installation](user-guide/installation.md)**: Install FastAPI-fastkit
277+
2. **[Quick Start](user-guide/quick-start.md)**: Create your first project in 5 minutes
278+
3. **[Getting Started Tutorial](tutorial/getting-started.md)**: Step-by-step detailed tutorial
279+
280+
### 📚 Advanced Learning
281+
282+
- **[Creating Projects](user-guide/creating-projects.md)**: Create projects with different stacks
283+
- **[Adding Routes](user-guide/adding-routes.md)**: Add API endpoints to your project
284+
- **[Using Templates](user-guide/using-templates.md)**: Use pre-built project templates
285+
286+
### 🛠️ Contributing
287+
288+
Want to contribute to FastAPI-fastkit?
289+
290+
- **[Development Setup](contributing/development-setup.md)**: Set up your development environment
291+
- **[Contributing Guidelines](https://github.com/bnbong/FastAPI-fastkit/blob/main/CONTRIBUTING.md)**: Contribution guidelines
292+
293+
### 🔍 Reference
294+
295+
- **[CLI Reference](user-guide/cli-reference.md)**: Complete CLI command reference
296+
- **[FAQ](reference/faq.md)**: Frequently asked questions
297+
- **[GitHub Repository](https://github.com/bnbong/FastAPI-fastkit)**: Source code and issue tracking
298+
270299
## License
271300

272301
This project is licensed under the MIT License - see the [LICENSE](https://github.com/bnbong/FastAPI-fastkit/blob/main/LICENSE) file for details.

0 commit comments

Comments
 (0)