hub-docs icon indicating copy to clipboard operation
hub-docs copied to clipboard

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

Open gamepad-coder opened this issue 1 year ago • 1 comments

=== 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)

gamepad-coder avatar Mar 08 '24 05:03 gamepad-coder

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.

gamepad-coder avatar Mar 08 '24 06:03 gamepad-coder