From 3299f53a0f9f31e3edc394a6598895847b70b918 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Thu, 22 Jun 2023 09:08:45 +0200 Subject: [PATCH] docs: documentation pages stubs added --- .../mismeasure_for_measure.md} | 0 .../introduction.md} | 0 .../isq.md} | 0 .../defining_systems/natural_units.md | 0 docs/users_guide/defining_systems/si.md | 0 .../defining_systems/strong_angular_system.md | 0 docs/users_guide/examples/hello_units.md | 0 .../framework_basics/basic_concepts.md | 0 .../quantities_of_different_characters.md | 0 .../simple_and_typed_quantities.md | 0 .../framework_basics/systems_of_quantities.md | 0 .../framework_basics/systems_of_units.md | 0 .../value_conversions.md | 0 .../use_cases/extending_the_library.md | 0 ...roperability_with_other_units_libraries.md | 0 .../using_custom_representation_types.md | 0 .../working_with_legacy_interfaces.md | 0 mkdocs.yml | 28 +++++++++++++++---- 18 files changed, 22 insertions(+), 6 deletions(-) rename docs/{users_guide/basic_concepts.md => appendix/mismeasure_for_measure.md} (100%) rename docs/users_guide/{systems_of_quantities.md => defining_systems/introduction.md} (100%) rename docs/users_guide/{systems_of_units.md => defining_systems/isq.md} (100%) create mode 100644 docs/users_guide/defining_systems/natural_units.md create mode 100644 docs/users_guide/defining_systems/si.md create mode 100644 docs/users_guide/defining_systems/strong_angular_system.md create mode 100644 docs/users_guide/examples/hello_units.md create mode 100644 docs/users_guide/framework_basics/basic_concepts.md create mode 100644 docs/users_guide/framework_basics/quantities_of_different_characters.md rename docs/users_guide/{ => framework_basics}/simple_and_typed_quantities.md (100%) create mode 100644 docs/users_guide/framework_basics/systems_of_quantities.md create mode 100644 docs/users_guide/framework_basics/systems_of_units.md rename docs/users_guide/{ => framework_basics}/value_conversions.md (100%) create mode 100644 docs/users_guide/use_cases/extending_the_library.md create mode 100644 docs/users_guide/use_cases/interoperability_with_other_units_libraries.md create mode 100644 docs/users_guide/use_cases/using_custom_representation_types.md create mode 100644 docs/users_guide/use_cases/working_with_legacy_interfaces.md diff --git a/docs/users_guide/basic_concepts.md b/docs/appendix/mismeasure_for_measure.md similarity index 100% rename from docs/users_guide/basic_concepts.md rename to docs/appendix/mismeasure_for_measure.md diff --git a/docs/users_guide/systems_of_quantities.md b/docs/users_guide/defining_systems/introduction.md similarity index 100% rename from docs/users_guide/systems_of_quantities.md rename to docs/users_guide/defining_systems/introduction.md diff --git a/docs/users_guide/systems_of_units.md b/docs/users_guide/defining_systems/isq.md similarity index 100% rename from docs/users_guide/systems_of_units.md rename to docs/users_guide/defining_systems/isq.md diff --git a/docs/users_guide/defining_systems/natural_units.md b/docs/users_guide/defining_systems/natural_units.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/defining_systems/si.md b/docs/users_guide/defining_systems/si.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/defining_systems/strong_angular_system.md b/docs/users_guide/defining_systems/strong_angular_system.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/examples/hello_units.md b/docs/users_guide/examples/hello_units.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/framework_basics/basic_concepts.md b/docs/users_guide/framework_basics/basic_concepts.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/framework_basics/quantities_of_different_characters.md b/docs/users_guide/framework_basics/quantities_of_different_characters.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/simple_and_typed_quantities.md b/docs/users_guide/framework_basics/simple_and_typed_quantities.md similarity index 100% rename from docs/users_guide/simple_and_typed_quantities.md rename to docs/users_guide/framework_basics/simple_and_typed_quantities.md diff --git a/docs/users_guide/framework_basics/systems_of_quantities.md b/docs/users_guide/framework_basics/systems_of_quantities.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/framework_basics/systems_of_units.md b/docs/users_guide/framework_basics/systems_of_units.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/value_conversions.md b/docs/users_guide/framework_basics/value_conversions.md similarity index 100% rename from docs/users_guide/value_conversions.md rename to docs/users_guide/framework_basics/value_conversions.md diff --git a/docs/users_guide/use_cases/extending_the_library.md b/docs/users_guide/use_cases/extending_the_library.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/use_cases/interoperability_with_other_units_libraries.md b/docs/users_guide/use_cases/interoperability_with_other_units_libraries.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/use_cases/using_custom_representation_types.md b/docs/users_guide/use_cases/using_custom_representation_types.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/users_guide/use_cases/working_with_legacy_interfaces.md b/docs/users_guide/use_cases/working_with_legacy_interfaces.md new file mode 100644 index 00000000..e69de29b diff --git a/mkdocs.yml b/mkdocs.yml index 5aa1fbf6..575276b0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,7 +19,7 @@ theme: - content.action.view - content.code.annotate - content.code.copy - - navigation.expand + # - navigation.expand - navigation.indexes - navigation.sections # - navigation.tabs @@ -99,14 +99,30 @@ nav: - FAQ: getting_started/faq.md - User's Guide: - Terms and Definitions: users_guide/terms_and_definitions.md - - Systems of Quantities: users_guide/systems_of_quantities.md - - Systems of Units: users_guide/systems_of_units.md - - Value Conversions: users_guide/value_conversions.md - - Simple and Typed Quantities: users_guide/simple_and_typed_quantities.md - - Basic Concepts: users_guide/basic_concepts.md + - Framework Basics: + - Basic Concepts: users_guide/framework_basics/basic_concepts.md + - Systems of Quantities: users_guide/framework_basics/systems_of_quantities.md + - Systems of Units: users_guide/framework_basics/systems_of_units.md + - Value Conversions: users_guide/framework_basics/value_conversions.md + - Simple and Typed Quantities: users_guide/framework_basics/simple_and_typed_quantities.md + - Quantities of Different Characters: users_guide/framework_basics/quantities_of_different_characters.md + - Defining Systems: + - Introduction: users_guide/defining_systems/introduction.md + - International System of Quantities (ISQ): users_guide/defining_systems/isq.md + - International System of Units (SI): users_guide/defining_systems/si.md + - Strong Angular System: users_guide/defining_systems/strong_angular_system.md + - Natural Units: users_guide/defining_systems/natural_units.md + - Use Cases: + - Working with Legacy Interfaces: users_guide/use_cases/working_with_legacy_interfaces.md + - Using Custom Representation Types: users_guide/use_cases/using_custom_representation_types.md + - Interoperability with Other Units Libraries: users_guide/use_cases/interoperability_with_other_units_libraries.md + - Extending the Library: users_guide/use_cases/extending_the_library.md + - Examples: + - hello_units: users_guide/examples/hello_units.md - Library Reference: - Core Library: library_reference/core_library.md - Appendix: - Glossary: appendix/glossary.md + - Mismeasure for Measure: appendix/mismeasure_for_measure.md - Release Notes: appendix/release_notes.md - References: appendix/references.md