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

Docs: Create a style guide #108

Open
CBID2 opened this issue Aug 3, 2023 · 2 comments
Open

Docs: Create a style guide #108

CBID2 opened this issue Aug 3, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@CBID2
Copy link

CBID2 commented Aug 3, 2023

Problem

I noticed that there isn’t a style guide on how to maintain the Docs of your project. This makes it difficult for contributors who want to contribute to the docs understand what to do.

Possible Solution.

Create a style guide that has information on how to display code snippets and formatting headings, and the tone of voice you want for the docs. This would make it easier for contributors to see how they improve the Docs and increase productivity.

@lifeofzero
Copy link
Contributor

You caught us again! :-) We'll get this into an upcoming sprint.

@CBID2
Copy link
Author

CBID2 commented Aug 3, 2023

You caught us again! :-) We'll get this into an upcoming sprint.

Lol, you can thank @ykdojo for that @lifeofzero!😉 Let me know when you start! :) I want to help :)

@sashathor sashathor added the documentation Improvements or additions to documentation label Jan 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants