Added initial documentation

This commit is contained in:
Bartek Kryza
2023-01-01 20:36:58 +01:00
parent 9d7275e388
commit e4a29c7117
15 changed files with 1328 additions and 137 deletions

18
docs/README.md Normal file
View File

@@ -0,0 +1,18 @@
# Documentation
* [Quick start](./quick_start.md)
* Generating diagrams
* [Common options](./common_options.md)
* [Class diagrams](./class_diagrams.md)
* [Sequence diagrams](./sequence_diagrams.md)
* [Package diagrams](./package_diagrams.md)
* [Include diagrams](./include_diagrams.md)
* [Comment decorators](./comment_decorators.md)
* [Diagram filters](./diagram_filters.md)
* [Using Jinja templates](./jinja_templates.md)
* [Interactive SVG diagrams using links](./interactive_svg_diagrams.md)
* [Configuration file reference](./configuration_file.md)
* [Doxygen integration](./doxygen_integration.md)
* [Test cases documentation](./test_cases.md)
* [Troubleshooting](./troubleshooting.md)