Skip to content

Make the "Template docs" tab be the default tab #259

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

Open
mgax opened this issue May 30, 2025 · 1 comment
Open

Make the "Template docs" tab be the default tab #259

mgax opened this issue May 30, 2025 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed ui Related to the user interface of the pattern library

Comments

@mgax
Copy link
Member

mgax commented May 30, 2025

When looking at a component in the pattern library, if the component has any docs, I'm liable to miss them, because they are hidden inside a tab.

Describe the solution you'd like

  • Change the order of the tabs to make "Template docs" be the first.
  • Consider renaming the tabs. They are currently named "Template source", "Template config" and "Template docs". I think "Template" is redundant; naming them "Source", "Sample data" and "Documentation" would work better.

Describe alternatives you've considered

I could override the pattern_library/index.html template in my project, but it seems like this change would benefit all users of django-pattern-library.

Additional context

My project is considering implementing Storybook on top of django-pattern-library because it places the documentation up front and centre. As an alternative, I'm exploring ways that django-pattern-library can be more useful out of the box.

@thibaudcolas
Copy link
Member

Makes sense to me!

@thibaudcolas thibaudcolas added enhancement New feature or request help wanted Extra attention is needed ui Related to the user interface of the pattern library labels Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed ui Related to the user interface of the pattern library
Projects
None yet
Development

No branches or pull requests

2 participants