search

fastify / website

https://fastify.dev/
MIT License
60 stars 63 forks source link

Better "getting started" navigation #133

Open metcoder95 opened 1 year ago

metcoder95 commented 1 year ago 
### Tasks
- [ ] [Guides] Set the guides into logical order
- [ ] [Getting Started] Add a `Testing` Section
- [ ] [Getting Started] Add  `Next Steps` Section
metcoder95 commented 1 year ago

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:

  1. What's Fastify and how it differentiates from other frameworks?
  2. Technical pillars (the ones shared by @mcollina)
  3. And the step-by-step guide for creating a first app

What are your thoughts @Eomm ?

Eomm commented 1 year ago

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 😮‍💨

metcoder95 commented 1 year ago

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

Eomm commented 1 year ago

Touched the 1 point: I meant that right now it is alphabetical order, but this order does not make sense to a new user:

image

benchmarks should be the very last thing to think about 🤣

metcoder95 commented 1 year ago

I would even say that benchmarks are not even part of the guide, I see them more as references instead 🤔

Dgdaniel commented 9 months ago

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

james-kaguru commented 6 months ago

@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)

Advanced Concepts

Ecosystem Guides

Benchmarking Migration Guide

Reference

metcoder95 commented 6 months ago

That SGTM 👍

Dgdaniel commented 6 months ago

Hello how can I contribute to the documentation page of fastify ?

Le ven. 3 mai 2024 à 07:47, Carlos Fuentes @.***> a écrit :

That SGTM 👍

— Reply to this email directly, view it on GitHub https://github.com/fastify/website/issues/133#issuecomment-2092483897, or unsubscribe https://github.com/notifications/unsubscribe-auth/AMHFC3VNTESCBNBHDD6FVCTZAM6JNAVCNFSM6AAAAAA25ENOCOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJSGQ4DGOBZG4 . You are receiving this because you commented.Message ID: @.***>

james-kaguru commented 6 months ago

@Dgdaniel we could start by coming up with the structure of the documentation and update it step by step

Dgdaniel commented 5 months ago
james-kaguru commented 3 months ago

@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

metcoder95 commented 3 months ago

I wouldn't move them directly, but rather copy them until the new website is up within this repo

james-kaguru commented 3 months ago

@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?

Dgdaniel commented 2 months ago

okay

metcoder95 commented 2 months ago

Sure thing 👍