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

docs(api): avoid headings in decorators #22682

Closed
petebacondarwin opened this issue Mar 9, 2018 · 4 comments
Closed

docs(api): avoid headings in decorators #22682

petebacondarwin opened this issue Mar 9, 2018 · 4 comments
Assignees
Milestone

Comments

@petebacondarwin
Copy link
Member

The Component decorator has headings in the content for individual members of the "component interface" which do not render nicely and confuse the table of contents. See https://next.angular.io/api/core/Component#simple-example

screen shot 2018-03-09 at 16 17 03

@ngbot ngbot bot added this to the needsTriage milestone Mar 9, 2018
@kara kara added the comp: aio label Mar 9, 2018
@jenniferfell
Copy link
Contributor

Can we disallow H2 H3 etc in API reference markup everywhere? In other words, all headings are ones that are generated based on appropriate dgeni tagging or the generation tools?

Can we disallow H2 H3 etc in tables? If the generator finds something that would be a heading inside a table, then it makes that text just bold on its own line?

Either of those would fix the TOC for existing content.

Longer term, obviously, a rewrite of this kind of content the complete answer, but I know we have content to migrate that might have done this.

@jenniferfell
Copy link
Contributor

Update from Judy: Headers should only be allowed in Usage Notes, and it should only be H3 or lower

@petebacondarwin petebacondarwin added this to Docs/API in docs-infra Mar 12, 2018
@petebacondarwin
Copy link
Member Author

I will implement a check for this.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants