Start documentation and contribution guidelines

dunossauro commented

2025-10-07 23:53:14 -03:00

Member

As we look to expand and encourage more contributions to this project, I believe that improving the documentation should be a top priority. The initial steps can skip over the very basics (like "What is the project?"), but we should focus on creating key documentation pages.

Here are some key areas I think we should address:

Contribution Guide:
- Explain how to create a PR.
- Mention that a user account must be created on the project's Forgejo bolha instance.
- Include coding style guidelines and contribution rules, which are already mentioned in the README.
- Provide a clear explanation of the internal project structure (again, this is mentioned in the README).
Further Pages to Consider:
- Any additional documentation that could help new contributors understand the project better.

Additionally, since we plan to expand the project and have it available in multiple languages, it's important to think ahead about how to manage this documentation across different languages and ensure proper versioning.

Suggestions for Documentation Setup:

MkDocs: I recommend using MkDocs for an easy-to-maintain, markdown-based documentation setup.
MkDocs Material: This theme is well-known within the community and has a clean, user-friendly design.
Mike: We could use Mike for versioning the documentation to ensure that it stays up-to-date as the project evolves.

These are just initial suggestions, but I'm open to other ideas or recommendations!

As we look to expand and encourage more contributions to this project, I believe that improving the documentation should be a top priority. The initial steps can skip over the very basics (like "What is the project?"), but we should focus on creating key documentation pages. Here are some key areas I think we should address: * **Contribution Guide:** * Explain how to create a PR. * Mention that a user account must be created on the project's Forgejo bolha instance. * Include coding style guidelines and contribution rules, which are already mentioned in the README. * Provide a clear explanation of the internal project structure (again, this is mentioned in the README). * **Further Pages to Consider:** * Any additional documentation that could help new contributors understand the project better. Additionally, since we plan to expand the project and have it available in multiple languages, it's important to think ahead about how to manage this documentation across different languages and ensure proper versioning. **Suggestions for Documentation Setup:** * **MkDocs**: I recommend using MkDocs for an easy-to-maintain, markdown-based documentation setup. * **MkDocs Material**: This theme is well-known within the community and has a clean, user-friendly design. * [**Mike**](https://github.com/jimporter/mike): We could use Mike for versioning the documentation to ensure that it stays up-to-date as the project evolves. These are just initial suggestions, but I'm open to other ideas or recommendations!