If you are publishing an app, you might want to be able to provide documentation for your users to follow. The Docs builder allows you to do that, right here in the VTEX Developer Portal.

In short, all Markdown content in the /docs folder of your app identified as {appvendor}.{appname}@{appversion} will be made available once the app is published, in a URL of the following format:

Any app developer can make their documentation publicly available using the docs builder. So even if your app is not published to the VTEX App Store, you can take advantage of this convenience.

Please be aware that access to files in the docs directory is not restricted to accounts or users that have the app installed. Do not share any sensitive or private information that should not be made public on the web!

1. Add the docs builder to your app's builder list in the manifest.json file. Check the example of vtex.store-theme. For example:

   
   

   _10

   "builders": {

   _10

   "docs": "0.x"

   _10

   },

   
   

2. In the root directory of your app, create a docs folder to manage your app's documentation. It should be written in Markdown, on a file named README.md. This is the docs folder of vtex.store-theme@5.x.

3. Publish and deploy your new app version.

4. Once you publish your app, the documentation will be available in the VTEX Developer Portal. This is the published documentation for vtex.store-theme@5.x.