[GRADLE-2857] Add table of contents to each multi-page documentation page, including examples Created: 02/Aug/13  Updated: 10/Feb/17  Resolved: 10/Feb/17

Status: Resolved
Project: Gradle
Affects Version/s: None
Fix Version/s: None

Type: Task
Reporter: Gradle Forums Assignee: Unassigned
Resolution: Won't Fix Votes: 0


The Gradle documentation is fantastic, but I fInd it difficult to navigate with only a single table of contents. If each multi-page documentation topic displayed a full TOC in place, including sections and examples, it'd make it a lot easier to get around.

If it were pinned to the top and right, and collapsible, it'd mean you wouldn't need to jump to the top of the page too...

Comment by Gradle Forums [ 02/Aug/13 ]

Hi Danny,

Can you point to an example of what you're envisioning?

Comment by Gradle Forums [ 02/Aug/13 ]

The Django docs are a good example: Contents for the current topic, plus the 'Browse' section lets you jump to the ToC and it and the 'You are here' secion keeps you oriented to where you are in the documentation: [1]https://docs.djangoproject.com/en/1.5....

Their side bar scrolls with the rest of the document though, so you have to return to the top of the page to refer to it. It might work better if it was fixed like the Gradle documentation top bar, but could be collapsed to expand the readable area, i.e. like the Python docs here (but think it works better on the RHS), keep the top bar and side bar content visible - [2]http://docs.python.org/2/library/. I also like that the Python docs give you a drop down to get to previous versions of the documentation.
[1] https://docs.djangoproject.com/en/1.5/ref/validators/
[2] http://docs.python.org/2/library/

Comment by Benjamin Muschko [ 15/Nov/16 ]

As announced on the Gradle blog we are planning to completely migrate issues from JIRA to GitHub.

We intend to prioritize issues that are actionable and impactful while working more closely with the community. Many of our JIRA issues are inactionable or irrelevant. We would like to request your help to ensure we can appropriately prioritize JIRA issues you’ve contributed to.

Please confirm that you still advocate for your JIRA issue before December 10th, 2016 by:

  • Checking that your issues contain requisite context, impact, behaviors, and examples as described in our published guidelines.
  • Leave a comment on the JIRA issue or open a new GitHub issue confirming that the above is complete.

We look forward to collaborating with you more closely on GitHub. Thank you for your contribution to Gradle!

Comment by Benjamin Muschko [ 10/Feb/17 ]

Thanks again for reporting this issue. We haven't heard back from you after our inquiry from November 15th. We are closing this issue now. Please create an issue on GitHub if you still feel passionate about getting it resolved.

Generated at Wed Jun 30 12:33:20 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.