Skip to content
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

Anchor links broken in 3.0.x Markdown specification documents #3494

Closed
jlevers opened this issue Jan 10, 2024 · 3 comments
Closed

Anchor links broken in 3.0.x Markdown specification documents #3494

jlevers opened this issue Jan 10, 2024 · 3 comments

Comments

@jlevers
Copy link

jlevers commented Jan 10, 2024

The anchor links in the Markdown specs for versions 3.0.0, 3.0.1, and 3.0.2 are broken. The links point to camelCase anchors, but the anchors themselves are kebab-case. For instance, in the 3.0.2 spec, the Media Types index link points at the #mediaTypes anchor, but the actual Media Types heading has the anchor #media-types. This issue is present throughout the documents.

There are also some minor naming inconsistencies. I haven't done a thorough check, but I noticed that the OpenAPI Document index link points to the #oasDocument anchor, when the actual anchor is #openapi-document (so even if #oasDocument were changed to #oas-document, the anchor link still wouldn't work).

Not sure if the spec files are autogenerated or written manually. Happy to submit a PR if someone can point me in the right direction.

@handrews handrews linked a pull request Jan 10, 2024 that will close this issue
@handrews
Copy link
Member

This is being addressed. There are some rather thorny logistical challenges involved in terms of change management process and deployment, which is why it's taking so long, but it's being addressed in the PR I linked.

@jlevers
Copy link
Author

jlevers commented Jan 10, 2024

Got it – thanks! Appreciate the quick response and sorry for the dupe.

@handrews
Copy link
Member

Consolidating all broken link issues into issue #3054 and PR #3408

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants