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

Create a documentation page according to diataxis principle #231

Open
mknorps opened this issue Mar 15, 2023 · 0 comments · May be fixed by #449
Open

Create a documentation page according to diataxis principle #231

mknorps opened this issue Mar 15, 2023 · 0 comments · May be fixed by #449
Assignees
Labels
P2 major: an upcoming release type: documentation

Comments

@mknorps
Copy link
Collaborator

mknorps commented Mar 15, 2023

The current README.md contains more and more information in most if the areas of diataxis principles: how-to guides, explanation and reference. We do not yet have tutorials, and may consider them when FawltyDeps is more mature.

The README becomes too big to extract the information fast. I think at this point we need a separate way and place to serve documentation.

We could use mkdocs and deploy as GitHub pages.

@Nour-Mws Nour-Mws added the P2 major: an upcoming release label Mar 16, 2023
@mknorps mknorps added this to the FawltyDeps 1.0 milestone Jul 30, 2024
@mknorps mknorps linked a pull request Dec 31, 2024 that will close this issue
@mknorps mknorps self-assigned this Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 major: an upcoming release type: documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants