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.

Sign up for GitHub

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

Jump to bottom

Add section in README on how to contribute doc pages #19

Open
bourque opened this issue May 21, 2024 · 2 comments
Open

Add section in README on how to contribute doc pages #19

bourque opened this issue May 21, 2024 · 2 comments
Assignees
@bourque

Comments

@bourque
Copy link
Member

bourque commented May 21, 2024

The section should detail how to contribute new documentation pages, with link(s) to resources on how to write in ReStructured Text format.
@bourque bourque self-assigned this May 21, 2024
@bourque
Copy link
Member Author

bourque commented Aug 28, 2024

We could also add some notes about common styles/formatting we are using, e.g. how we want to credit original authors.

@bourque
Copy link
Member Author

bourque commented Aug 28, 2024 •
edited
Loading

Also mention something about language and tone, e.g. avoid opinions without supporting facts, avoid using first-person, opinions get put under "Lessons Learned" section, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bourque bourque

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bourque