Create a document
Add Markdown files to ./documentation/ to create a new document:
Documentation
./documentation/modules/my-module/README.md→aqlib.aquivalabs.com/modules/my-module./documentation/modules/my-module/features.md→aqlib.aquivalabs.com/modules/my-module/features
Follow the code folder structure
| Code | Documentation |
|---|---|
AqLib/apex/component-1 | documentation/apex/component-1 |
AqLib/lwc/component-1 | documentation/lwc/component-1 |
AqLib/modules/module-1 | documentation/modules/module-1 |
Snippets
./snippets/my-snippet.md→aqlib.aquivalabs.com/snippets/my-snippet
Contribution
./website/docs/my-page.md→aqlib.aquivalabs.com/contribute/my-page
Choose subfolder
- Components - self-contained, independent pieces that can be used and reused to build functionality.
- LWC - components written primarily with lwc
- Apex - components written primarily with apex
- Modules - bigger piece of functionality. Composite set of apex, lwc and other that represent complete feature.
Try to follow same folder structure for documentations as you used for the code itself.