Split plugin index page summary for better anchor links
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- HTML
- Stars
- 2
- Forks
- 17
- Avg merge
- 7d 18h
- Merged PRs (30d)
- 3
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the plugin index page linked in the issue and inspect how its summary and table of contents are generated. Restructure the summary into the requested General, User, and optional Admin sections, with anchor links and conditional admin content; done when long plugin indexes are easier to navigate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100