From 958a5e62d0c743eb051bd76b69280f9b9aa4da2c Mon Sep 17 00:00:00 2001 From: Ashvika Maddikonda Date: Tue, 12 May 2026 17:15:07 -0400 Subject: changed "straight forward" to "straightforward" (one word) --- docs/dev/documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index bc0a445e..74129884 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -23,7 +23,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li echo API documentation available in build/html ## Changing -Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.doxygen.nl/manual/docblocks.html) in C++ and C, and [restructured text blocks](https://sphinx-tutorial.readthedocs.io/step-1/) 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. +Changing documentation for the API itself is fairly straightforward. Use [doxygen style comment blocks](https://www.doxygen.nl/manual/docblocks.html) in C++ and C, and [restructured text blocks](https://sphinx-tutorial.readthedocs.io/step-1/) 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. ???+ Info "Tip" When updating user documentation, the `properdocs serve` feature is particularly helpful. -- cgit v1.3.1