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

Unrendered asciidoc headings in reference documentation #29569

Closed
mhalbritter opened this issue Nov 24, 2022 · 1 comment
Closed

Unrendered asciidoc headings in reference documentation #29569

mhalbritter opened this issue Nov 24, 2022 · 1 comment
Assignees
Labels
type: documentation A documentation task
Milestone

Comments

@mhalbritter
Copy link
Contributor

See for example https://docs.spring.io/spring-framework/docs/current/reference/html/web-reactive.html#webflux-websocket

It contains

= Introduction to WebSocket

which is not rendered as a heading.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Nov 24, 2022
@bclozel bclozel self-assigned this Nov 24, 2022
@bclozel bclozel added type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Nov 24, 2022
@bclozel bclozel added this to the 6.0.3 milestone Nov 24, 2022
@sbrannen
Copy link
Member

sbrannen commented Nov 25, 2022

This is due to the use of {chapter} in the IDs.

websocket-intro.adoc attempts to use dynamic IDs such as [[{chapter}.websocket-intro]]; whereas, web-uris.adoc uses dynamic IDs such as [id={chapter}.web-uricomponents].

The latter works (at least in this particular arrangement).

I noticed the difference previously while working on a different issue and wondered if it was problematic, but I forgot to follow up on that. Now we know!

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

No branches or pull requests

4 participants