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

doc: use cards in index #9758

Merged
merged 1 commit into from
Mar 22, 2024
Merged

doc: use cards in index #9758

merged 1 commit into from
Mar 22, 2024

Conversation

emillon
Copy link
Collaborator

@emillon emillon commented Jan 16, 2024

This uses sphinx_design's grids to render long lists by category. The grids are responsive.
They are used in several places where we have long lists:

  • actions
  • dune stanzas

In addition, this adds a "top-level" TOC pointing to the sections, and some quick links on the index page.

@emillon emillon added the docs Documentation improvements label Jan 16, 2024
@emillon emillon force-pushed the doc-index-cards branch 3 times, most recently from a3bb76a to bffe677 Compare February 9, 2024 16:56
@emillon emillon force-pushed the doc-index-cards branch 2 times, most recently from 4ddf1ec to a2cde68 Compare March 13, 2024 16:29
@emillon emillon marked this pull request as ready for review March 13, 2024 16:33
@emillon emillon requested a review from christinerose as a code owner March 13, 2024 16:33
@Leonidas-from-XIV
Copy link
Collaborator

Since I was unaware what grids are, here's the documentation: https://sphinx-design.readthedocs.io/en/latest/grids.html

@emillon
Copy link
Collaborator Author

emillon commented Mar 13, 2024

Grids are tables that do the right thing. So we can say that some elements can be side by side when the screen is large, but they'll collapse on a smaller screen.

@emillon
Copy link
Collaborator Author

emillon commented Mar 22, 2024

Thanks for the feedback. for now I've decided to leave the main ndex changes out, and this PR focuses on just using grids in other index pages.

@emillon emillon merged commit 3a4ce9c into ocaml:main Mar 22, 2024
24 of 27 checks passed
@emillon emillon deleted the doc-index-cards branch March 22, 2024 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants