Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better "getting started" navigation #133

Open
3 tasks
metcoder95 opened this issue Jul 30, 2023 · 11 comments
Open
3 tasks

Better "getting started" navigation #133

metcoder95 opened this issue Jul 30, 2023 · 11 comments
Labels
good first issue Good for newcomers

Comments

@metcoder95
Copy link
Member

metcoder95 commented Jul 30, 2023

Tasks

@metcoder95
Copy link
Member Author

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
Copy link
Member

Eomm commented Aug 5, 2023

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
Copy link
Member Author

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

@metcoder95 metcoder95 added the good first issue Good for newcomers label Aug 6, 2023
@Eomm
Copy link
Member

Eomm commented Aug 9, 2023

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
Copy link
Member Author

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

@Dgdaniel
Copy link

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
Copy link
Contributor

james-kaguru commented May 2, 2024

@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

@metcoder95
Copy link
Member Author

That SGTM 👍

@Dgdaniel
Copy link

Dgdaniel commented May 3, 2024 via email

@james-kaguru
Copy link
Contributor

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

@Dgdaniel
Copy link

Dgdaniel commented May 7, 2024

  • 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Development

No branches or pull requests

4 participants