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

index.md - Add "🤗 Hugging Face Hub - Table of Contents" above un-labeled colored boxes. #1235

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gamepad-coder
Copy link

@gamepad-coder gamepad-coder commented Mar 8, 2024

=== What ===

  • Add ## 🤗 Hugging Face Hub - Table of Contents
    below the intro paragraph
    but above the colorful boxes for the table of contents in the middle of the page.

=== Motivation ===

  • It's not obvious to a first time visitor that the flex grid in the middle is the same set of information in the sidebar.

  • By telling the user these colored boxes are the table of contents (and not micellaneous out-links -- which I initially thought), it becomes clearer, more orienting, and less overwhelming.

=== Mockup ===

  • Before PR
    • huggingface co_docs_hub_index (1 before PR)

  • After PR
    • huggingface co_docs_hub_index (2 after PR)

It's not obvious to a first time visitor that the flex grid in the middle is the same set of information in the sidebar.

By adding information that these colored boxes are the table of contents (and not micellaneous out-links as some viewers might think), it becomes clearer, more orienting, and less overwhelming.
@gamepad-coder
Copy link
Author

Note the mockup above was done by hand in the browser.

=== Additional Wiring Needed? ===

  • I'm unsure if the build tool will automatically add the H2 link in the righthand sidebar, or if additional steps are needed?
  • I'm unsure if the href hash anchors are automatically generated for all H2 tags or not
    • i.e. #hugging-face-hub-table-of-contents for in-page navigation links like
    • index.html#hugging-face-hub-table-of-contents.

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.

1 participant