swagger-api / swagger-api/swagger.io-docs
Swagger Tools and Integrations could do with a Table of Contense
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
I was thinking that the Tools and Intergrations page could do with a table of contense.
I looked into making a pull request on the markdown file, but I don't know how it's being intergrated into wordpress.
I think this would also be hugely benifical for the specification page.
It's frustrating to:
- Not have a table of contense
- Not be able to link directly to a section of the page.
Github adds links to every header tag. Would this be something that could be added automatically to the spec and other pages on the Swagger site?
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 by locating the markdown for the Tools and Integrations and specification pages, then read how that content is integrated into WordPress. Done means both pages have a table of contents and directly linkable sections, with the integration approach confirmed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, wordpress
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100