Investigating
To facilitate component documentation on component dialog or within AEM using jcr nodes and properties
| Request for Feature Enhancement (RFE) Summary: | To fecilitate Component documentation on component dialog within AEM and remove external dependencies |
| Use-case: | Each custom component/ core compoenents need documenation like authroing guide/ component use-case doc etc. |
| Current/Experienced Behavior: |
Currently we have to provide separate doc. in sites or word doc and is not integarted within AEM; Another approach: Also there is a way to use cusomized js to read and show the html to achive this. |
| Improved/Expected Behavior: |
To have a property something like within AEM : granite/ui/components/coral/foundation/includeReadme
That takes an additional path property pointing to a ".md" file.
This enables author to view component docs, with ease and reduces efforts to use 3rd party sites/dependencies. Also as its associated within the custom components , author need not search for docs in case of huge database of components in a project. |
| Environment Details (AEM version/service pack, any other specifics if applicable): | NA |
| Customer-name/Organization name: | NA |
| Screenshot (if applicable): | |
| Code package (if applicable): |