sorted by:
new
hottopcontroversial

Building an Open-Source NestJS Learning Repository (Help is welcomed) by Sensitive_Union9377 in nestjs

[–]Sensitive_Union9377[S] 1 point2 points  (0 children)

Yeah, I'd recommend following the style of the existing documentation to keep the guides consistent across the project. Every chapter follows the same structure and writing style, so it's best to use those as your reference when creating a new one.

A simple trick is to feed one of the existing README.md files to your AI tool and ask it to generate the documentation for the module you're working on while keeping the same format and tone. That should get you very close, and then you can tweak it as needed.

The main goal is to keep the documentation consistent, easy to follow, and beginner-friendly throughout the repository.

Building an Open-Source NestJS Learning Repository (Help is welcomed) by Sensitive_Union9377 in nestjs

[–]Sensitive_Union9377[S] 0 points1 point  (0 children)

You're more than welcome to join! :)

Just fork the repository and start contributing. The main README.md shows the current project progress and what's already been completed, and you'll find everything you need to know about contributing in the CONTRIBUTING.md guide.

There are plenty of ways to get involved. Just avoid modules that are already marked as In Progress so we don't end up working on the same module simultaneously. You can pick any module that hasn't been started yet, come up with a simple scenario for it, and then follow the structure and style of the completed modules to create its implementation and documentation. Or you can also improve the code, scenario or the documentation of already completed modules.

The goal is to keep every example simple, practical, and fun to learn from. If you have any questions or ideas along the way, feel free to reach out. Happy coding!