-
-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Very long pages with no TOC #5701
Comments
In its early days (2014-2015), Godot used a GitHub wiki (with Markdown formatting) for its user documentation. It ended up being too limited, especially since note/warning blocks can't be created with just Markdown. There are nonstandard Markdown extensions that make this possible, but GitHub doesn't support rendering those. The Sphinx RTD theme likely limits the number of levels that can be displayed in the sidebar, so I guess we need to add a manual table of contents at the top of long pages such as GDScript reference. |
Note and warning boxes can be easily converted into quote blocks with a script. I even tried it and converted it. only links need to be rendered to relative links.
It's useless if it's not one of the fixed menus in the corner like this; fixed.movAn real world example (no quotes in this example but can be added);
|
Can we re-open this please? This still seems to be an issue (limited levels in sidebar menu, and no TOC for pages (specifically GDScript Reference))... |
ok |
#9989 brought the GDScript reference page one level higher in the sidebar, so the page now has one level of header navigation in the sidebar: In addtion to that, we can promote some of the existing headers slightly so that they appear in the sidebar navigation. I'm not opposed to an actual TOC at the top of the page in addition to that, too. |
@setanarut This isn't fixed yet, let's keep it open for now. We either need to add a table of contents/navigation or split the page into multiple pages for this issue to be considered fixed. |
Your Godot version:
Godot 3.4.3 or Godot 4 alpha 4
Issue description:
There are very long reference pages with no TOC. I have to use the search bar on the left first and then the browser's search bar to find what I'm looking for. Then It's easy to get lost in the huge pages.
URL to the documentation page (if already existing):
https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_basics.html#classes
Github's auto-generated table of contents in the RST file. godotengine.org doesn't have this TOC.
toc.mov
Enhancement request
The text was updated successfully, but these errors were encountered: