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

Very long pages with no TOC #5701

Open
setanarut opened this issue Mar 21, 2022 · 6 comments · May be fixed by #10080
Open

Very long pages with no TOC #5701

setanarut opened this issue Mar 21, 2022 · 6 comments · May be fixed by #10080
Labels
content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement

Comments

@setanarut
Copy link

setanarut commented Mar 21, 2022

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

Ekran Resmi 2022-03-21 22 35 43

Github's auto-generated table of contents in the RST file. godotengine.org doesn't have this TOC.

toc.mov

Enhancement request

  1. As an alternative to the slow and cumbersome docs.godotengine.org site. Documents should be adapted to GitHub Flavored Markdown format and put on Github. So anyone who wants can fork and find what they're looking for.
  2. or add TOC to the docs.godotengine.org. (My second reluctant choice.)
@Calinou
Copy link
Member

Calinou commented Mar 21, 2022

As an alternative to the slow and cumbersome docs.godotengine.org site. Documents should be adapted to GitHub Flavored Markdown format and put on Github. So anyone who wants can fork and find what they're looking for.

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.

@Calinou Calinou added the content:website Issues related to adding website features and fixing bugs, whether on the front or back-end label Mar 21, 2022
@setanarut
Copy link
Author

It ended up being too limited, especially since note/warning blocks can't be created with just Markdown.

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.

NOTE: Lorem ipsum dolor sit amet.

WARNING: Be realistic, demand the impossible!


so I guess we need to add a manual table of contents at the top of long pages such as GDScript reference.

It's useless if it's not one of the fixed menus in the corner like this;

fixed.mov

An real world example (no quotes in this example but can be added);
https://github.com/vlang/v/blob/master/doc/docs.md


NOTE: Why do you prefer old-fashioned static site builders like Sphinx? There are faster and more modern technologies.

@ghost
Copy link

ghost commented Feb 28, 2024

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))...

@setanarut setanarut reopened this Feb 28, 2024
@setanarut
Copy link
Author

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

@setanarut setanarut closed this as not planned Won't fix, can't repro, duplicate, stale Aug 11, 2024
@dalexeev dalexeev reopened this Aug 11, 2024
@tetrapod00
Copy link
Contributor

#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:
image

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.

@dalexeev
Copy link
Member

@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.

@dalexeev dalexeev reopened this Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content:website Issues related to adding website features and fixing bugs, whether on the front or back-end enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants