Skip to content

Add overview to each documentation page #115

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

Closed
mehalter opened this issue Oct 13, 2023 · 2 comments
Closed

Add overview to each documentation page #115

mehalter opened this issue Oct 13, 2023 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@mehalter
Copy link
Member

Is your feature related to a problem?

It's good to have a short introduction for each page to summarize what that page entails. Starlight has built in support for this to make it easy to add this type of information. Currently every page has an "Overview" section in the Table of Contents that is simply empty.

Describe the new feature

Add a short introductory paragraph to each page as described in the Starlight documentation for Structuring Page Content.

Additional context

It would be good to also add a desc to the header of each page as well.

@mehalter mehalter added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Oct 13, 2023
@mehalter mehalter added this to the AstroNvim v4 milestone Oct 26, 2023
@mehalter
Copy link
Member Author

mehalter commented Nov 8, 2023

This has been completed for all of the Recipe pages. And just needs to be done for all the pages still marked as unverified and not updated

@mehalter
Copy link
Member Author

This has been completed for all old pages, some pages haven't been written yet but we will make sure they get descriptions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant