Expand my Community achievements bar.

Submissions are now open for the 2026 Adobe Experience Maker Awards.

To facilitate component documentation on component dialog or within AEM using jcr nodes and properties

Avatar

Community Advisor

8/18/22

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.

https://experienceleaguecommunities.adobe.com/t5/adobe-experience-manager-blogs/aem-components-markd...

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):  
1 Comment

Avatar

Administrator

9/2/22

@Manu_Mathew_ 

Thanks for proposing this idea

This has been reported to the engineering under the internal reference ASSETS-15109. The product team will triage this request to verify feasibility based on the prioritization model. This post will be updated according to the Jira request status.

Status changed to: Investigating