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

Use Tocbot for dynamic table of contents in User Guide #1723

Closed
1 task done
sbrannen opened this issue Jan 8, 2019 · 0 comments
Closed
1 task done

Use Tocbot for dynamic table of contents in User Guide #1723

sbrannen opened this issue Jan 8, 2019 · 0 comments

Comments

@sbrannen
Copy link
Member

sbrannen commented Jan 8, 2019

Overview

Over time the amount of content in the User Guide grows and grows. Consequently, it becomes harder to actually navigate the User Guide.

In order not to overwhelm the reader but simultaneously provide enough contextual information for "where you currently are" within the User Guide, it would be beneficial to integrate Tocbot in the JUnit 5 User Guide.

Tocbot can be integrated into Asciidoctor analogous to how the Spring Framework did in spring-projects/spring-framework@ee3913c. Note, however, that some of the files in that initial commit have been modified over time.

To see the result of the Tocbot integration into Spring's Reference Manual, take a look at the Testing chapter.

Related Issues

Deliverables

  • Integrate Tocbot in the User Guide.
@sbrannen sbrannen added this to the 5.4 M2 milestone Jan 8, 2019
@sormuras sormuras modified the milestones: 5.4 M2, 5.4 GA Jan 11, 2019
@sbrannen sbrannen changed the title Use TocBot for dynamic table of contents in User Guide Use Tocbot for dynamic table of contents in User Guide Jan 26, 2019
sbrannen added a commit that referenced this issue Jan 27, 2019
This commit integrates Tocbot 3.0.2 in the User Guide and Release Notes
in order to support a dynamic table of contents (TOC) that improves
usability of the HTML version of the published documentation.

Closes: #1723
sbrannen added a commit that referenced this issue Jan 27, 2019
sbrannen added a commit that referenced this issue Jan 27, 2019
@marcphilipp marcphilipp modified the milestones: 5.4 GA, 5.4 RC2 Jan 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants