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: make documentation using GitHub Pages #7

Open
ma-ilsi opened this issue Oct 15, 2023 · 0 comments
Open

Docs: make documentation using GitHub Pages #7

ma-ilsi opened this issue Oct 15, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ma-ilsi
Copy link
Owner

ma-ilsi commented Oct 15, 2023

Background

Where do we currently stand in documentation efforts? What is the problem?

We have no documentation. Without documentation, end users won't know how to use Sophie. Contributors won't be able to contribute efficiently, either.

Proposal

Documentation fixes, recommendations, and plans

GitHub Pages

After some internal (in my head, since no one else is here right now) debating between choosing GitHub Wiki on this repository or GitHub Pages, I've decided to use GitHub Pages. The Wiki lacks customisation and that makes it hard to enjoy mantaining. I also think I'll learn more using Pages and it opens up more opportunities for people to help (workflows, etc). Probably Jekyll, less time, supported out of the box (but suggestions are welcome).

Diátaxis

We'll be following the diátaxis methodology of maintaining documentation (with a few exceptions where needed).
This gives some clear rules on how to write and how to structure the docs. It's also easy to point contributors to the source so they know what our documentation is founded upon.

@ma-ilsi ma-ilsi self-assigned this Oct 15, 2023
@ma-ilsi ma-ilsi added the documentation Improvements or additions to documentation label Oct 15, 2023
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

1 participant