Tweaks doxygen so that we have a better main page.

Daniel Lemire · Daniel Lemire · commit b5ea504ad2f7 · 2020-06-17T11:07:21.000-04:00
diff --git a/Doxyfile b/Doxyfile
@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = include
+INPUT                  = doc include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1026,7 +1026,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = doc/basics.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
diff --git a/doc/basics.md b/doc/basics.md
@@ -516,3 +516,12 @@ Backwards Compatibility
 The only header file supported by simdjson is simdjson.h. Older versions of simdjson published a
 number of other include files such as document.h or ParsedJson.h alongside simdjson.h; these headers
 may be moved or removed in future versions.
+
+
+
+Further Reading
+-------------
+
+* [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.
diff --git a/doc/implementation-selection.md b/doc/implementation-selection.md
@@ -81,3 +81,11 @@ can select the CPU architecture yourself:
 // Use the fallback implementation, even though my machine is fast enough for anything
 simdjson::active_implementation = simdjson::available_implementations["fallback"];
 ```
+
+
+Further Reading
+-------------
+
+* [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.
diff --git a/doc/parse_many.md b/doc/parse_many.md
@@ -154,3 +154,11 @@ From [jsonlines.org](http://jsonlines.org/examples/):
     ```
     JSON Lines' biggest strength is in handling lots of similar nested data structures. One .jsonl file is easier to 
     work with than a directory full of XML files.
+
+
+Further Reading
+-------------
+
+* [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.
diff --git a/doc/performance.md b/doc/performance.md
@@ -152,3 +152,10 @@ On Intel and AMD Windows platforms, Microsoft Visual Studio enables programmers
 We do not recommend that you compile simdjson with architecture-specific flags such as  `arch:AVX2`. The simdjson library automatically selects the best execution kernel at runtime.
 
 Recent versions of Microsoft Visual Studio on Windows provides support for the LLVM Clang compiler. You  only need to install the "Clang compiler" optional component. You may also get a copy of the 64-bit LLVM CLang compiler for [Windows directly from LLVM](https://releases.llvm.org/download.html). The simdjson library fully supports the LLVM Clang compiler under Windows. In fact, you may get better performance out of simdjson with the LLVM Clang compiler than with the regular Visual Studio compiler.
+
+
+Further Reading
+-------------
+
+* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and
+  how you can work with it.
diff --git a/doc/tape.md b/doc/tape.md
@@ -134,4 +134,3 @@ In-between these two tape elements, we alternate between key (which must be stri
 All the content of the object is located between these two tape elements, including arrays and objects. 
 
 Performance consideration: We can skip the content of an object entirely by accessing the first 64-bit tape element, reading the payload and moving to the corresponding index on the tape.
- 

Original file line number	Diff line number	Diff line change
`@@ -134,4 +134,3 @@ In-between these two tape elements, we alternate between key (which must be stri`
`134`	`134`	`All the content of the object is located between these two tape elements, including arrays and objects.`
`135`	`135`
`136`	`136`	`Performance consideration: We can skip the content of an object entirely by accessing the first 64-bit tape element, reading the payload and moving to the corresponding index on the tape.`
`137`		`-`