summaryrefslogtreecommitdiff
path: root/docs/dev/documentation.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2024-02-26 15:29:42 -0500
committerJordan Wiens <jordan@psifertex.com>2024-02-26 15:29:42 -0500
commit86686b2901cba24a10fe77f570ad91a222b859a8 (patch)
tree348868989067402a9b6b81eec36a03a31a2c4d28 /docs/dev/documentation.md
parentfb7bef063f982495e2b23a115c34ead37b449483 (diff)
change warning icons on tips to tips
Diffstat (limited to 'docs/dev/documentation.md')
-rw-r--r--docs/dev/documentation.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
index c141c06a..3f357273 100644
--- a/docs/dev/documentation.md
+++ b/docs/dev/documentation.md
@@ -26,7 +26,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li
## Changing
Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html) in C++ and C, and [restructured text blocks](http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html) for python for the source. The user documentation is located in the `api/docs/` folder and the API documentation is generated from the config in the `api/api-docs` folder.
-???+ Warning "Tip"
+???+ Info "Tip"
When updating user documentation, the `mkdocs serve` feature is particularly helpful.
[contribution license agreement]: https://binary.ninja/cla.pdf