Better "getting started" navigation
metcoder95 opened this issue · 16 comments
I believe that getting started deserves its own section as it serves as an initial point for all the people that is new to the framework.
I'm not 100% how it is a well structure, but I imagine having categorisations around:
- What's Fastify and how it differentiates from other frameworks?
- Technical pillars (the ones shared by @mcollina)
- And the step-by-step guide for creating a first app
What are your thoughts @Eomm ?
I believe that getting started deserves its own section
Agree
What are your thoughts @Eomm ?
I would not reinvent the wheel and I would start from the docs that people love such as: https://nextjs.org/docs/getting-started/installation
For sure we must go with small steps otherwise we will fail IMHO
The first one could be to rearrange our menu sorted by alphabetical order 😮💨
For sure we must go with small steps otherwise we will fail IMHO
That's true 😅
The first one could be to rearrange our menu sorted by alphabetical order 😮💨
Let's start small then, let me add a task list in the description and let me know your thoughts
Touched the 1 point: I meant that right now it is alphabetical order, but this order does not make sense to a new user:
benchmarks should be the very last thing to think about 🤣
I would even say that benchmarks are not even part of the guide, I see them more as references instead 🤔
I think the doc guide be different from the bench marl. I recommend to make a doc like the nestjs page does (more self explanatory ) or the one of fastapi
@metcoder95 and @Eomm I would like to help out with this.. maybe we could have structure such as below as a starting point.
Getting Started ( should contain Quick start)
Fundamentals (we discuss core fastify concepts)
- Plugins
- Schema (using fluent schema)
- Database
- Fastify style guide
Advanced Concepts
- Hooks
- Testing
- Typescript
Ecosystem
Guides
- Delay accepting requests
- Detecting When clients abort
- Deploying ( what Recommendations page currently has)
- Serveless
Benchmarking
Migration Guide
- V3 migration guide
- V4 migration guide
Reference
That SGTM 👍
@Dgdaniel we could start by coming up with the structure of the documentation and update it step by step
- overview
- Installation
- sample project setup with fastify
- what is plugin
- how to use it
I want to add this as complement to what @james-kaguru propose
@Dgdaniel and @metcoder95 .. I believe the first step should be to separate the guides from the fastify repo snd move the yo this repo and from there we can begin to make the updates step by step
I wouldn't move them directly, but rather copy them until the new website is up within this repo
@metcoder95 yes I wanted to copy the current guides and delete them from the fastify repo once we have set them up in this repo..is that okay?
okay
Sure thing 👍