swagger-api / swagger-api/swagger.io-docs
Add section anchors to published pages
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
I want to link to particular sections within the OpenAPI Guide published at https://swagger.io/docs/specification/
So, for example, I want to link to the "operationId" section within the "Paths and Operations" page with a link something like https://swagger.io/docs/specification/paths-and-operations#operationId
Sadly, right now I have to resort to linking to sections within files in this repository, e.g. https://github.com/swagger-api/swagger.io/blob/wordpress/docs/spec-explained/paths-and-operations.md#operationid
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 with the published OpenAPI Guide page at swagger.io/docs/specification/ and compare it with the referenced markdown source, docs/spec-explained/paths-and-operations.md. Check how headings such as "operationId" are rendered in published pages, then make section links resolve there and verify the Paths and Operations anchor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100