Within the "Document" tab, you can automatically generate project overviews and module information without using chat.
The feature to update dynamic documents when the code is updated is planned for future release and is not available at this time.
❶ Go to the "Document" tab, click the folder name in the "Dynamic Document" area at the top, and press the "Generate" button.
Note: If there are draft documents that have not been reflected, you cannot press the button. Please reflect or discard drafts before proceeding.
The following files/folders will be generated:
| Name | Type | Description |
|---|---|---|
| Overview | File | Analysis result of the project overview |
| Function List | File | Main functions are output in table format |
| Setup | File | Analysis result of deployment procedures, etc. |
| Module | Folder | Folders for each module are created, containing module overviews, API specs, and documentation for each function within the module |
| Rules | Folder | Analysis results for frameworks, linting, structure, etc. |
The amount of generated documentation dynamically changes depending on the project.
Currently, editing is allowed for dynamic documents due to possible errors such as Mermaid errors. In the future, when the update feature for dynamic documents is released, error prevention measures will be provided and files in the dynamic document area will become non-editable.
Just like other documents created with the Document Feature, you can download them as .md or .pdf files.