Incorporated feedback from patrick, exposed docs0readme as navigation, fixed htmlproofer, added anonymous_fields.md to documentation.

alxn4 · web-flow · commit 789822a1c7a8 · 2024-11-18T23:56:31.000Z
diff --git a/.github/workflows/update-people.yml b/.github/workflows/update-people.yml
@@ -3,7 +3,8 @@ name: update-people
 on:
   push:
     branches: 
-      - feature/docs_migration_mkdocs
+      - f/mkdocs
+      - main
   schedule:
     - cron: "0 12 1 * *"
   workflow_dispatch: {}
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ As the aforementioned libraries are among the most widely used in the respective
 - Simple [installation](https://rfl.getml.com/install)
 - Simple extendability to [other serialization formats](https://rfl.getml.com/supported_formats/supporting_your_own_format)
 - Simple extendability to [custom classes](https://rfl.getml.com/concepts/custom_classes)
-- Being one of the fastest serialization libraries in existence, as demonstrated by our [benchmarks](https://getml.com/benchmarks)
+- Being one of the fastest serialization libraries in existence, as demonstrated by our [benchmarks](https://rfl.getml.com/benchmarks)
 
 <br>
 
@@ -83,9 +83,9 @@ Support for more serialization formats is in development. Refer to the [issues](
 Please also refer to the *vcpkg.json* in this repository.
 
 
-# Feature Overview
+## Feature Overview
 
-## Simple Example
+### Simple Example
 
 ```cpp
 #include <rfl/json.hpp>
@@ -168,7 +168,7 @@ rfl::ubjson::read<Person>(ubjson_bytes);
 rfl::xml::read<Person>(xml_string);
 ```
 
-## More Comprehensive Example
+### More Comprehensive Example
 
 ```cpp
 #include <iostream>
@@ -241,7 +241,7 @@ std::cout << "Hello, my name is " << homer2.first_name() << " "
           << homer2.last_name() << "." << std::endl;
 ```
 
-## Error messages
+### Error messages
 
 reflect-cpp returns clear and comprehensive error messages:
 
@@ -262,7 +262,7 @@ Found 5 errors:
 5) Field named 'children' not found.
 ```
 
-## JSON schema
+### JSON schema
 
 reflect-cpp also supports generating JSON schemata:
 
@@ -291,7 +291,7 @@ The resulting JSON schema looks like this:
 
 Note that this is currently supported for JSON only, since most other formats do not support schemata in the first place.
 
-## Enums
+### Enums
 
 reflect-cpp supports scoped enumerations:
 
@@ -324,7 +324,7 @@ This results in the following JSON string:
 You can also directly convert between enumerator values and strings with `rfl::enum_to_string()` and `rfl::string_to_enum()`, or
 obtain list of enumerator name and value pairs with `rfl::get_enumerators<EnumType>()` or `rfl::get_enumerator_array<EnumType>()`.
 
-## Algebraic data types
+### Algebraic data types
 
 reflect-cpp supports Pydantic-style tagged unions, which allow you to form algebraic data types:
 
@@ -357,7 +357,7 @@ This results in the following JSON string:
 
 Other forms of tagging are supported as well. Refer to the [documentation](https://rfl.getml.com/docs-readme) for details.
 
-## Extra fields
+### Extra fields
 
 If you don't know all of your fields at compile time, no problem. Just use `rfl::ExtraFields`:
 
@@ -381,7 +381,7 @@ This results in the following JSON string:
 {"firstName":"Homer","lastName":"Simpson","age":45,"email":"homer@simpson.com","town":"Springfield"}
 ```
 
-## Reflective programming
+### Reflective programming
 
 Beyond serialization and deserialization, reflect-cpp also supports reflective programming in general.
 
@@ -480,9 +480,9 @@ const auto c2 = rfl::replace(c, a);
 ```
 
 
-## Support for containers
+### Support for containers
 
-### C++ standard library
+#### C++ standard library
 
 reflect-cpp supports the following containers from the C++ standard library:
 
@@ -509,7 +509,7 @@ reflect-cpp supports the following containers from the C++ standard library:
 - `std::vector`
 - `std::wstring`
 
-### Additional containers
+#### Additional containers
 
 In addition, it supports the following custom containers:
 
@@ -529,7 +529,7 @@ In addition, it supports the following custom containers:
 - `rfl::Validator`: Allows for automatic input validation.
 - `rfl::Variant`: An alternative to `std::variant` that compiles considerably faster.
 
-### Custom classes
+#### Custom classes
 
 Finally, it is very easy to extend full support to your own classes, refer to the [documentation](https://rfl.getml.com/docs-readme) for details.
 
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/concepts/structs.md b/docs/concepts/structs.md
@@ -82,5 +82,5 @@ Person{"Bart", "Simpson", ...};
 But if you create a custom constructor, then C++ will no longer allow this kind of constructions.
 
 If you want to create the struct from one of your classes (the most like reason, you want to create custom constructors in the first place),
-you might want to check out the section on [custom classes](https://github.com/getml/reflect-cpp/blob/main/docs/custom_classes.md) or [custom parsers](https://github.com/getml/reflect-cpp/blob/main/docs/custom_parser.md).
+you might want to check out the section on [custom classes](custom_classes.md) or [custom parsers](../custom_parser.md).
 
diff --git a/docs/docs-readme.md b/docs/docs-readme.md
@@ -1,9 +1,3 @@
----
-hide:
-    - navigation
----
-
-
 # Documentation
 
 ## The basics
@@ -40,6 +34,8 @@ hide:
 
 [rfl::Binary, rfl::Hex and rfl::Oct](number_systems.md)- For expressing numbers in different formats. 
 
+[Anonymous fields](anonymous_fields.md) - For defining fields without using `rfl::Field`.
+
 ## Validation
 
 [Regex patterns](patterns.md) - For requiring that strings follow used-defined regex patterns.
@@ -50,7 +46,7 @@ hide:
 
 [Size validation](size_validation.md) - For imposing size constraints on containers such as `std::vector` or `std::string`.
 
-[JSON schema](json_schema.md) - For validating your schema before you even send it to your C++ backend.
+[JSON schema](supported_formats/json_schema.md) - For validating your schema before you even send it to your C++ backend.
 
 ## Generic elements
 
diff --git a/docs/index.md b/docs/index.md
@@ -41,12 +41,10 @@ reflect-cpp fills an important gap in C++ development. It minimizes boilerplate
 - Simple [installation](https://rfl.getml.com/install)
 - Simple extendability to [other serialization formats](https://rfl.getml.com/supported_formats/supporting_your_own_format)
 - Simple extendability to [custom classes](https://rfl.getml.com/concepts/custom_classes)
-- Being one of the fastest serialization libraries in existence, as demonstrated by our [benchmarks](https://getml.com/benchmarks)
+- Being one of the fastest serialization libraries in existence, as demonstrated by our [benchmarks](https://rfl.getml.com/benchmarks)
   
 
-## reflect-cpp in a nutshell
-
-<h3> Why do we need this?</h3>
+## Why do we need this?
 
 Suppose your C++ program has complex data structures it needs to save and load. Or maybe it needs to interact with some kind of external API. If you do this the traditional way, you will have a lot of boilerplate code. This is annoying and error-prone.
 
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -105,7 +105,49 @@ nav:
       - Custom Format: supported_formats/supporting_your_own_format.md
   # - Reflective Programming: ./reflective_programming.md
   - Installation: install.md
-  - Documentation: docs-readme.md
+  - Documentation: 
+    - docs-readme.md
+    - The basics:
+      - Structs: concepts/structs.md
+      - Optional fields: optional_fields.md
+      - Struct flattening: flatten_structs.md
+      - Processors: concepts/processors.md
+      - The rfl::Field-syntax: concepts/field_syntax.md
+      - String literals: literals.md
+      - Enums: enums.md
+      - std::variant and rfl::TaggedUnion: variants_and_tagged_unions.md
+      - rfl::Box and rfl::Ref: rfl_ref.md
+      - rfl::Timestamp: timestamps.md
+      - rfl::Skip: rfl_skip.md
+      - rfl::Result: result.md
+      - Standard containers: standard_containers.md
+      - C arrays and inheritance: c_arrays_and_inheritance.md
+      - rfl::Bytestring: bytestring.md
+      - rfl::Binary, rfl::Hex and rfl::Oct: number_systems.md
+      - Anonymous fields: anonymous_fields.md
+    - Validation:
+      - Regex patterns: patterns.md
+      - Validating numbers: validating_numbers.md
+      - Composing validators: composing_validators.md
+      - Size validation: size_validation.md
+      - JSON schema: supported_formats/json_schema.md
+    - Generic elements:
+      - rfl::Object: object.md
+      - rfl::Generic: generic.md
+      - rfl::ExtraFields: extra_fields.md
+    - Custom classes:
+      - Custom classes: concepts/custom_classes.md
+      - Custom parsers for your classes: custom_parser.md
+    - Useful helper functions and classes:
+      - rfl::replace: replace.md
+      - rfl::as: as.md
+      - rfl::NamedTuple: named_tuple.md
+      - rfl::Tuple: rfl_tuple.md
+      - rfl::to_view: to_view.md
+    - Advanced topics:
+      - Supporting your own format: supported_formats/supporting_your_own_format.md
+      - Maintaining backwards compatability: backwards_compatability.md
+      - Benchmarks: benchmarks.md
   - Contributing: contributing.md
   - People: people.md
 
@@ -146,6 +188,7 @@ plugins:
         - mailto:*
         - 'data:image/*'
         - '#*'
+        - https://github.com/getml/reflect-cpp/tree/main/.github/actions/people/people.py
 
 
 hooks:
