angular-awesome-docs

Angular component documentation is generated by parsing markdown rules and examples from the src/directives directory, then rendering them into final HTML pages using docs/includes templates via a Node.js generator script.

Synchronize the component index and version badges by running the documentation generator, which regenerates the components index and updates the global version badge to match the current Web Awesome alignment automatically.

Automate changelog updates by using the documentation pipeline to assist with adding Keep a Changelog style release notes, ensuring appropriate entries are present for the current version before release.

Node.js is required to run the documentation generator. The pipeline relies on a node-based docs/generate-docs.js script to build component pages and the components index from markdown sources.

A standardized src/directives layout containing rules and example markdown for each component is required, alongside docs/includes templates that the generator populates to produce final HTML output.

Regenerate component documentation and update the changelog whenever a directive API or example changes, ensuring component pages, the components index, and changelog are refreshed before release.