From 3ac287ba3db8be68aa41cf901804f6eb5bce1f48 Mon Sep 17 00:00:00 2001 From: Daniel Lemire Date: Fri, 17 Oct 2025 20:28:08 -0400 Subject: [PATCH] update dox --- doc/basics_doxygen.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/basics_doxygen.md b/doc/basics_doxygen.md index 13c2ac685..4be31dcd2 100644 --- a/doc/basics_doxygen.md +++ b/doc/basics_doxygen.md @@ -1,5 +1,8 @@ We take our documentation seriously. Please start reading the documentation before you attempt to use simdjson. We hope you will enjoy reading us. -* Basics: https://github.com/simdjson/simdjson/blob/master/doc/basics.md is an overview of how to use simdjson and its APIs. -* iterate_many: https://github.com/simdjson/simdjson/blob/master/doc/iterate_many.md describes an interface providing features to work with files or streams containing multiple small JSON documents. As fast and convenient as possible. -* Performance: https://github.com/simdjson/simdjson/blob/master/doc/performance.md shows some more advanced scenarios and how to tune for them. +* [Basics](doc/basics.md) is an overview of how to use simdjson and its APIs. +* [Builder](doc/builder.md) is an overview of how to efficiently write JSON strings using simdjson. +* [Performance](doc/performance.md) shows some more advanced scenarios and how to tune for them. +* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and + how you can work with it. +* [API](https://simdjson.github.io/simdjson/) contains the automatically generated API documentation.