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

Show configuration toml files in tabs within the docs #8384

Closed
doolio opened this issue Oct 31, 2023 · 12 comments · Fixed by #8480
Closed

Show configuration toml files in tabs within the docs #8384

doolio opened this issue Oct 31, 2023 · 12 comments · Fixed by #8480
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Contributions especially welcome

Comments

@doolio
Copy link
Contributor

doolio commented Oct 31, 2023

To better understand what I mean see here and below in the hatch docs which also uses Material for Mkdocs.

image

It doesn't seem the case in the hatch docs that if you select one such tab that all the tabs that follow automatically select the same tab. I don't know how it is done but that is the case in the hugo docs for example here and below and it is a really nice feature.

image

I think this would be a great improvement to the ruff docs in terms of readability and understanding for users.

@doolio
Copy link
Contributor Author

doolio commented Oct 31, 2023

The same style could be used in other areas within the docs too for example the installation instructions as here in the rye docs - again another project using Material for MkDocs.

@charliermarsh
Copy link
Member

This would be great, especially for showing pyproject.toml vs. ruff.toml.

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Oct 31, 2023
@charliermarsh
Copy link
Member

@doolio
Copy link
Contributor Author

doolio commented Oct 31, 2023

Content tabs are linked based on their label, not offset. This means that all tabs with the same label will be activated when a user clicks a content tab regardless of order inside a container.

And this from the page you linked suggests maybe what I described implemented in the hugo docs is possible with Material for MkDocs.

@MichaReiser MichaReiser added the help wanted Contributions especially welcome label Oct 31, 2023
@dhruvmanila
Copy link
Member

For reference, FastAPI does a lot of this in it's documentation. For example,

@charliermarsh
Copy link
Member

Would love for someone to take this on, great contributor project that doesn't require Rust :)

@charliermarsh charliermarsh added the good first issue Good for newcomers label Nov 3, 2023
@trag1c
Copy link
Contributor

trag1c commented Nov 3, 2023

I'd like to work on this, please assign me :)

@doolio
Copy link
Contributor Author

doolio commented Nov 3, 2023

I would be happy to help too. I'm a bit reluctant to take it all on owing to the pace this project is moving and my time. I wouldn't want to disappoint people. Maybe, if it is a lot of work we could split it between myself and trag1c?

@MichaReiser
Copy link
Member

@trag1c could you comment here / reach out to @doolio if you see ways of collaborating on this issue?

@doolio in what kind of wark are you interested?

@trag1c
Copy link
Contributor

trag1c commented Nov 3, 2023

Hey, to be fair I think I'm almost done if I didn't miss anything, I just need to update the part that generates the Settings section.

@charliermarsh
Copy link
Member

Thanks @trag1c, that's awesome (and to @doolio for offering to help)!

@doolio
Copy link
Contributor Author

doolio commented Nov 3, 2023

I'm only learning to program (starting with python) so I think I could only meaningfully contribute right now in terms of reporting issues and improving the docs.

charliermarsh pushed a commit that referenced this issue Nov 5, 2023
## Summary

Closes #8384.

## Test Plan

Checked whether it renders properly on the `mkdocs serve` preview.
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 good first issue Good for newcomers help wanted Contributions especially welcome
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants