Title: Issues with the table of contents in the doc app · Issue #16255 · angular/angular.js · GitHub
Open Graph Title: Issues with the table of contents in the doc app · Issue #16255 · angular/angular.js
X Title: Issues with the table of contents in the doc app · Issue #16255 · angular/angular.js
Description: 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 i...
Open Graph Description: 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 ...
X Description: 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 "Do...
Opengraph URL: https://github.com/angular/angular.js/issues/16255
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Issues with the table of contents in the doc app","articleBody":"There are a few minor issues with the tocs:\r\n\r\n- 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 page\r\n\r\n- Examples have inconsistent headings: \r\n - the `@example` tag is not used consistently - Some pages include \"Example\" headings. Some pages use only the `\u003cexample>` element which is rendered as a usable example\r\n - the `@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\"\r\n - Solution for `@example` : \r\n - [ ] could have \"title\" param that is extracted and set as an appropriate heading (based on the parent section?) -> since it's jsdoc, it should use the `\u003ccaption>`tag? see http://usejsdoc.org/tags-example.html\r\n - [ ] a single example in a section would be rendered just \"Example\" (+ caption if available)\r\n - [ ] a collection of Examples would generate a list of \"Examples\" with the titles / no entry when no \"title\"\r\n\r\n\r\n- Sections / 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 `@example` tag~~ -> doesn't work because `@example` is a jsdoc tag\r\n\r\n\r\n","author":{"url":"https://github.com/Narretz","@type":"Person","name":"Narretz"},"datePublished":"2017-10-04T16:13:18Z","url":"https://github.com/angular/angular.js/issues/16255"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:33516b7c-a7c3-b84c-58f1-82eaa93b2ce9 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D6E0:24B7D9:262999:34CC15:6AFD8252 |
| html-safe-nonce | f77816fb5166f5c13f9dbd9887ae1b0f61ee9b9218a925ff37ce36dccdfbca8e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENkUwOjI0QjdEOToyNjI5OTk6MzRDQzE1OjZBRkQ4MjUyIiwidmlzaXRvcl9pZCI6IjU1NDcwMjY1MTY0MDM0OTI2NiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 55a30d98b187224ea7eb7f3d487d33855a0944dc7e6e471bf362c3a623f05ee9 |
| hovercard-subject-tag | issue:262846306 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/angular/angular.js/16255/issue_layout |
| twitter:image | https://opengraph.githubassets.com/bc0722cc8de096493ef2ab67ce93af8a703656243aedb321e1cc08369a23557b/angular/angular.js/issues/16255 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/bc0722cc8de096493ef2ab67ce93af8a703656243aedb321e1cc08369a23557b/angular/angular.js/issues/16255 |
| og:image:alt | 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 ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Narretz |
| hostname | github.com |
| expected-hostname | github.com |
| None | 42d4967e3c8afca51ccac31f419a705af777226a95f025ea73387d87a306b326 |
| turbo-cache-control | no-preview |
| go-import | github.com/angular/angular.js git https://github.com/angular/angular.js.git |
| octolytics-dimension-user_id | 139426 |
| octolytics-dimension-user_login | angular |
| octolytics-dimension-repository_id | 460078 |
| octolytics-dimension-repository_nwo | angular/angular.js |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 460078 |
| octolytics-dimension-repository_network_root_nwo | angular/angular.js |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 2329ceed0bc2c7b7c3b9f5f2db6abfc7b6fc3a50 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width