Docs: Use a simpler structure for the HTML GMP doc #2126
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Conventional Commits Report😢 No conventional commits found. 👉 Learn more about the conventional commits usage at Greenbone. |
|
Going with less intrusive /pull/2128 instead. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
In the GMP HTML doc, use an HTML
<details>for every item. As a result remove the contents and the summary sections.Initially most of the top level items (eg "1 Data Types") are open. The second level items are all closed (eg "1.1 Data Type alive_test"). This makes the initial view concise while still supporting links that jump to the second level items.
Why
The doc is big and hard to take in. The idea is to collapse everything so it's easier to see and navigate.
One downside is that when an item is closed it is excluded from text search.
References
Waits for /pull/2124.