search

carpentries / sandpaper-docs

Documentation for The Carpentries Workbench
https://carpentries.github.io/sandpaper-docs/
Other
5 stars 44 forks source link

Make Component Guide more visible #141

Open vinisalazar opened 1 year ago

vinisalazar commented 1 year ago

Hi,

I wanted to provide the feedback that I've spent quite some time looking for the "Workbench Component Guide". I eventually found it in the "More" tab of the Introduction to Workbench lesson, but IMHO it would be helpful to make it more visible/link it in more places, for example at https://carpentries.github.io/workbench/#guides (I'll try to get a PR in for that).

All-in-all I think many users overlook the "More" tabs, maybe there are ways to promote them more with the new template :)

Best, Vini

zkamvar commented 1 year ago

Thank you for pointing this out! I agree that the component guide could be made more visible and should be available in more places.

All-in-all I think many users overlook the "More" tabs, maybe there are ways to promote them more with the new template :)

Agreed. The "More" tab is the ghost of the "Extras" tab from the styles template (where the instructor notes used to live) It's one of the tricky points to the web design because you want to avoid overloading people with information, but you want to let them know that it exists.

I suspect a potential solution for this would be to add a number indicating the number of pages in the tab:

screenshot of title bar for "Version control with Git" showing the "More" tab with the number 2 in parenthesis

vinisalazar commented 1 year ago

That number does make one more curious about what's in that menu! It would be nice to have more opinions and see if any more solutions pop up.

vinisalazar commented 1 year ago

What about adding the "More" pages to the sidebar, after all numbered episodes? Just throwing this out there, I understand it might make the sidebar bloated.

zkamvar commented 1 year ago

It could work!