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.

Sign up for GitHub

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

Jump to bottom

Optimise reference "list" pages (goals, subsystems etc.) #17

Closed
huonw opened this issue Dec 30, 2023 · 2 comments · Fixed by #86
Closed

Optimise reference "list" pages (goals, subsystems etc.) #17

huonw opened this issue Dec 30, 2023 · 2 comments · Fixed by #86
Labels
enhancement New feature or request

Comments

@huonw
Copy link
Contributor

huonw commented Dec 30, 2023

From #4:

The reference listing page for goals etc. seems to have large cards for each item, all with content ---. Is it possible to switch to either switch to a (denser) plain list, and/or put real content in those cards? https://docs.pantsbuild.org/2.18.x/reference/goals
image
@thejcannon
Copy link
Member

It is possible to customize these, see Docusarus's own docs: https://docusaurus.io/docs/category/guides

The question becomes how easy that is to do with autogenerated indexes. I imagine that the per-page header metadata would be where it's easy to customize without ruining the autogenerated nature

@huonw huonw added the enhancement New feature or request label Dec 31, 2023
@thejcannon thejcannon mentioned this issue Jan 10, 2024
Merged
thejcannon added a commit that referenced this issue Jan 11, 2024
@thejcannon @huonw
Add descriptions to all reference pages (#86)
7668809 
Fixes #17 by adding a
generated `description` to each page's metadata.

The description is simply the first line of the potentially-longer
description.

---------

Co-authored-by: Huon Wilson <[email protected]>
@huonw
Copy link
Contributor Author

huonw commented Jan 11, 2024

Looks great now 👍

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add descriptions to all reference pages pantsbuild/pantsbuild.org
2 participants
@huonw @thejcannon