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

change level category look #610

Merged
merged 2 commits into from
Nov 28, 2023
Merged

Conversation

OriolAbril
Copy link
Member

@OriolAbril OriolAbril commented Nov 27, 2023

Closes #607


📚 Documentation preview 📚: https://pymc-examples--610.org.readthedocs.build/en/610/

@twiecki
Copy link
Member

twiecki commented Nov 27, 2023

Is this changing to numbers only? I feel that might still not be clear. We can't do words?

@OriolAbril
Copy link
Member Author

It also adds level at the beginning of the row:

imatge

It would also be possible to use words, but it will take more time to get the css so all the words fit in a single row. If someone can do it please go for it. I think the PR at least will show how to update the jinja template

@ricardoV94
Copy link
Member

Suggestion: Keep the icons (I think they are cute), but add label afterwards:
bird: Beginner
bird flying: Intermediate
dragon: Advanced

Second suggestion: Move the 4 label links: How-to/Tutorial/Reference... to a less prominent location? I am skeptical they are a useful navigation aid to users.

@twiecki
Copy link
Member

twiecki commented Nov 28, 2023

image

@twiecki twiecki merged commit 68d9cde into pymc-devs:main Nov 28, 2023
1 check passed
@OriolAbril OriolAbril deleted the level_category branch November 28, 2023 18:11
@OriolAbril
Copy link
Member Author

can we keep the type of documentation category even if somewhere else?

@twiecki
Copy link
Member

twiecki commented Nov 28, 2023

@OriolAbril They still show up here: https://www.pymc.io/projects/examples/en/latest/blog/category.html or where do you think we should have them?

@twiecki
Copy link
Member

twiecki commented Nov 28, 2023

For me the difference between tutorial, howto, explanation is not clear.

@OriolAbril
Copy link
Member Author

@OriolAbril They still show up here: https://www.pymc.io/projects/examples/en/latest/blog/category.html or where do you think we should have them?

I'd keep them in the sidebar. I don't think many people will go to the category page but instead browse through categories from the sidebar. But more importantly, the way to know which are the categories of a given notebook is seeing which are highlighted in green, so now it won't be possible to see which type of notebook each one is and look for similar ones.

For me the difference between tutorial, howto, explanation is not clear.

Many of the notebooks aren't following the categories very well, but the idea is for new notebooks to follow https://diataxis.fr/ with these four types, so I think it will become quite intuitive for users. Especially given the cpython docs (discussion and devdocs preview from open PR) and the numpy docs (NEP 44) are also following diataxis (that is, they are slowly differentiating and splitting their docs following these categories).

For now I don't think it should be seen as something to use everywhere (much less start restructuring everything), but mostly as a way for us to write better documentation by keeping the audience of the docs in mind when writing them (which is the main thing diataxis helps think about).

@ricardoV94
Copy link
Member

The birds are gone :( I liked them

@twiecki
Copy link
Member

twiecki commented Nov 30, 2023

The birds are gone :( I liked them

What did you like about them?

@ricardoV94
Copy link
Member

They were cute

@twiecki
Copy link
Member

twiecki commented Nov 30, 2023

That they were.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change category items for beginner, intermediate, advanced from birds to text
3 participants