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

Fix ToC in Helidon SE Web Server documentation #5771

Closed
m0mus opened this issue Jan 3, 2023 · 1 comment
Closed

Fix ToC in Helidon SE Web Server documentation #5771

m0mus opened this issue Jan 3, 2023 · 1 comment
Assignees
Labels
Milestone

Comments

@m0mus
Copy link
Contributor

m0mus commented Jan 3, 2023

Routing, Error Handling and possibly more sections are not included in ToC:
https://helidon.io/docs/v3/#/se/webserver

@ljamen
Copy link
Contributor

ljamen commented Jan 5, 2023

@m0mus Hi Dmitry, before I make any changes to this TOC, I think we need to have a discussion with the team. This TOC you are referring to in this issue follows the new doc template that we used in 3.x. Below are the instructions Mitia gave to me. The structure is to have a single doc format and a consistent TOC. I believe that the docs are now harder to use because we've created long, single documents and don't have enough subtopics in the primary TOCs. This is seen across most of the docs. I think we either need to include sub topics in the TOCs or include section-level TOCs for H2 sections that have multiple levels. OR we go back to multiple topics and include the drop down menus in the nav. Again, further discussion is needed.

Sub-chapters should be united into one.

Overview (may be reused from current doc)
Maven Dependency (may be reused from current doc)
Usage (may be reused from current doc)
API (may be reused from current doc)
Configuration (may be reused from current doc)
Reference (generated)
Examples (may be reused from Helidon repo or current doc)
Additional Information (if applicable)

ljamen added a commit that referenced this issue Jan 19, 2023
* updates to toc

* fix copyright

* fix copyright
@ljamen ljamen added this to the 3.1.1 milestone Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants