docs(docs-infra): API doc content rendering fixes #60116
Conversation
The PR introduces a few doc content rendering fixes: - Fix highlighted section heading styles (regression from angular#59965). - Convert JSDoc links within 'Usage Notes' sections to HTML and render them. - Add IDs to doc content headings. This, by itself, makes these headings available in the page ToC.
angular-robot
bot
added
area: docs
adev/shared-docs/pipeline/api-gen/rendering/transforms/code-transforms.ts
Show resolved
Hide resolved
| * A reference to an Angular application running on a page. | ||
| * | ||
| * @usageNotes | ||
| * {@a is-stable-examples} |
There was a problem hiding this comment.
Noticed two of these JSDoc tags in the code base. It seems that they are some sort of legacy markers that serve no purpose, so I decided to drop them. Let me know if they are needed.
|
Deployed adev-preview for f3f4eda to: https://ng-dev-previews-fw--pr-angular-angular-60116-adev-prev-i28ozmwc.web.app Note: As new commits are pushed to this pull request, this link is updated after the preview is rebuilt. |
devversion
left a comment
devversion
left a comment
There was a problem hiding this comment.
LGTM for upgrade/core JSDoc
Fix Regex comment.
JeanMeche
added
action: merge
|
This PR was merged into the repository by commit 2b114e7. The changes were merged into the following branches: main, 19.2.x |
The PR introduces a few doc content rendering fixes: - Fix highlighted section heading styles (regression from #59965). - Convert JSDoc links within 'Usage Notes' sections to HTML and render them. - Add IDs to doc content headings. This, by itself, makes these headings available in the page ToC. PR Close #60116
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
4 participants
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the new behavior?
The PR introduces a few doc content rendering fixes:
em(Ps. The current styling approach for anchors is not very flexible and I suspect it might require some refactoring since it clearly misses some use cases which results in broken/built-in appearance)Does this PR introduce a breaking change?