Automatic documentation for component generation

[mikgross]

🚀 Feature request

Command (mark with an x)

• [ ] new
• [ ] build
• [ ] serve
• [ ] test
• [ ] e2e
• [x] generate
• [ ] add
• [ ] update
• [ ] lint
• [ ] extract-i18n
• [ ] run
• [ ] config
• [ ] help
• [ ] version
• [ ] doc

Description

Upon creating components with ng generate component_name, ng creates a .ts, .css, .html, and .spec.ts. As a user of compodoc to generate documentation and app description, I have read that Compodoc search for a default xxx.component.md file inside the root folder of each component.

Describe the solution you'd like

It would be great if ng generate component_name maybe with a flag --doc would generate a .md file with basic information such as component_name, path from app/.

Describe alternatives you've considered

N/A

[alan-agius4]

This looks like an excellent opportunity for the community to extend the Angular schematics to include additional functionality such as this.

That said, let's leave this issue open for a short while to see if there is enough interest to add this in the official Angular schematics.

[angular-robot[bot]]

Just a heads up that we kicked off a community voting process for your feature request. There are 20 days until the voting process ends.

Find more details about Angular's feature request process in our documentation.

[angular-robot[bot]]

Thank you for submitting your feature request! Looks like during the polling process it didn't collect a sufficient number of votes to move to the next stage.

We want to keep Angular rich and ergonomic and at the same time be mindful about its scope and learning journey. If you think your request could live outside Angular's scope, we'd encourage you to collaborate with the community on publishing it as an open source package.

You can find more details about the feature request process in our documentation.

[alan-agius4]

Thanks for this feature request.

However, I am going to close this as is currently not in the Angular CLI roadmap. It is also trivial for the community to extend the default component schematic to include this feature.

Let's reconsider this in the future if there is a bigger demand for this feature.

[angular-automatic-lock-bot[bot]]

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.}