Issues with the table of contents in the doc app #16255
Comments
Good day. i am a student studying open source at Seneca college, and would like to take a go at this project. |
Shall I work on this if no one else is ? Willing to work on this issue. |
@nik72619c if you would like to submit a PR we will happily review it and merge it into the docs. |
Sure ! working on this one. For the Double compilation heading, should I make changes to the known issue part of the $compile section? |
Yes I think that is simplest. |
So I think taking it out of the known issues section and making it a separate heading might solve the purpose |
The |
Hello, I am new at open source contribution. @Narretz can you please guide me so i can contribute in documentation , I really like to. |
I thinks its very old issue. |
This is not a high priority for the project as it is now in LTS mode, and while not attractive the docs are usable. |
There are a few minor issues with the tocs:
Headings in tags that are collected for the module overview pages (e.h. @knownissue) create strange tocs - see https://docs.angularjs.org/api/ng "Double Compilation". The heading shouldn't be included at all in the collection of known issues. Solution: a) remove the heading b) introduce a "title" parameter to the
@knownIssue
tag that is rendered without id / without heading in the module overview pageExamples have inconsistent headings:
@example
tag is not used consistently - Some pages include "Example" headings. Some pages use only the<example>
element which is rendered as a usable example@example
tag creates a simple heading "Examples" . This looks weird when there's only one example, and requires to manually set a heading when there's more than one example. The id is is based on the method name or in all other api contexts, simply "example"@example
:<caption>
tag? see http://usejsdoc.org/tags-example.htmlSections / Headings with the same name generate incorrect links in the toc (e.g https://docs.angularjs.org/guide/accessibility). Solution: dgeni / markdown parser should generate unique heading ids OR
if it works in the guide, use the-> doesn't work because@example
tag@example
is a jsdoc tagThe text was updated successfully, but these errors were encountered: