Documenting a component
Document the components that you create to help users decide whether they can reuse your component in other applications.
- In the header of Dev Studio, click Configure > Application > Components.
- Select the component that you want to document.
- Click the Documentation tab.
- Optional:
Upload an icon to associate with this component.
Note: The icon file must be a .png, .jpg, or a .bmp file. The icon file size must be 3 MB or smaller. The icon must be exactly 120 pixels high and 120 pixels wide.
- In the Overview section, click Upload icon.
- Click Choose File.
- Select the icon file, and click Open.
- Click Submit.
- Enter a Description of the component.
- In the Key features section, enter a key feature of the component to help users understand what it does. Click Add new to add additional features.
-
Upload a PDF file with a maximum size of 25 MB that provides information about this
component.
- Optional: Click download template to download a documentation template. Click download example to see a sample installation guide.
- Click Upload.
- Click Choose File.
- Select the file you want to add, and click Open.
- Click Submit.
- Click Save.