You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This guide is adapted from the full Progress documentation style guide for use with GitHub Copilot or similar tools. It focuses on actionable, concise rules to help write clear, consistent, and accessible product documentation.
99
99
100
+
## Dcouemnting New Component Structure and Specifics
101
+
102
+
Every component documentation is placed in a separate file, which is located in the `docs/components` folder.
103
+
This folder contains folders for each component, and each folder contains the documentation files for the component. Most common files are:
104
+
105
+
-`overview.md`: A high-level overview of the component, its purpose, and usage.
106
+
-`events.md`: A detailed description of the events that the component emits, including their parameters and usage.
107
+
-`templates.md`: If the component has templates, this file provides information about the templates that can be used with the component, including examples and usage guidelines.
108
+
-`appearance.md`: A file that describes the appearance of the component, including its styles, themes, and customization options.
109
+
110
+
!!!IMPORTANT !!! Each component folder has an accessibility folder which contains the accessibility documentation for the component. This folder is automatically generated. With that in mind, do not create such folder when creating a new component documentation.
111
+
100
112
## Tone and Voice
101
113
102
114
### Basic Things to Avoid
@@ -493,6 +505,7 @@ To create an important note, use the `caution` prefix.
493
505
* Minimize empty space in the screenshot.
494
506
* Do not use screenshots wider than 1000 px.
495
507
* For labels, use Arial, 16 pt.
508
+
496
509
## Captions for Figures, Tables, and Code Snippets
497
510
498
511
* Introduce each table, figure, screenshot, code snippet, or demo example with a descriptive sentence or with a caption. For example, "The following table lists the configuration options of the TreeList." (descriptive sentence) or "**Available Configuration Options of the TreeList**" (caption).
@@ -536,6 +549,4 @@ The Knowledge Base articles include how-to and troubleshooting scenarios. Depend
536
549
* Treat the heading that states the question as a sentence.
537
550
* Use the appropriate punctuation as the heading is a sentence.
0 commit comments