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

Improving the structure of the documentation and website #1166

Open
janfb opened this issue Jun 11, 2024 · 1 comment
Open

Improving the structure of the documentation and website #1166

janfb opened this issue Jun 11, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation karma Karma issues: potentially annoying but very important issues less-urgent This is beyond the current 2 week horizon

Comments

@janfb
Copy link
Contributor

janfb commented Jun 11, 2024

Our documentation has grown organically. During the March 2024 hackathon we made a lot of improvements on the content and currently we are working on improving the website accordingly, see #1147 .

However, I came across this guide: https://diataxis.fr/

I could be a good starting point for generally improving the structure of our documentation website. I think that's a bigger project, maybe something for the next SBI sprint / hackathon.
@janfb janfb added documentation Improvements or additions to documentation less-urgent This is beyond the current 2 week horizon karma Karma issues: potentially annoying but very important issues labels Jun 11, 2024
@janfb
Copy link
Contributor Author

janfb commented Aug 6, 2024

more sources for inspiration:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation karma Karma issues: potentially annoying but very important issues less-urgent This is beyond the current 2 week horizon
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@janfb