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

Split plugin index page summary for better anchor links #69

Open

pedro-psb opened this issue Jul 12, 2024 · 0 comments

Labels

Member

pedro-psb commented Jul 12, 2024 •

edited

Loading

Split the summary into sections, like:

# Welcome to plugin

{{ Plugin index page }}

---

## Summary

### General

* RESTAPI
* Changelog
* Github (maybe add this too)

### User

* User Home  # use plugin/user/index.md if it exists
* Guides
* Learn
* etc

### Admin

# omit Admin Home, if {plugin}/admin/index.md doesnt exit
* Guides
* Learn
* etc

The benefits of this are:

We can link to the whole "Admin" section of pulpcore, for example, if that doesnt have an index page.
Some repositories have long ToC (example, pulp-operator). This can help readabillity

pedro-psb added the enhancement label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment