docs: project documentation layout refactored

This commit is contained in:
Mateusz Pusz
2023-12-16 12:38:19 +01:00
parent f1c3591693
commit 0811ac0ca2
7 changed files with 20 additions and 23 deletions

View File

@ -1 +0,0 @@
../../CHANGELOG.md

View File

@ -1,3 +1,9 @@
---
hide:
- navigation
- toc
---
# Welcome to **mp-units**! # Welcome to **mp-units**!
**mp-units** is a compile-time enabled feature-rich Modern C++ modular/header-only library that **mp-units** is a compile-time enabled feature-rich Modern C++ modular/header-only library that

View File

@ -1,7 +0,0 @@
# Core Library
## Concepts
## Expression templates
## Dimensions

1
docs/release_notes.md Symbolic link
View File

@ -0,0 +1 @@
../CHANGELOG.md

View File

@ -22,9 +22,10 @@ theme:
- content.code.copy - content.code.copy
# - navigation.expand # - navigation.expand
- navigation.indexes - navigation.indexes
- navigation.sections # - navigation.sections
# - navigation.tabs - navigation.tabs
- navigation.footer - navigation.footer
- navigation.top
- search.highlight - search.highlight
- search.share - search.share
- search.suggest - search.suggest
@ -116,8 +117,6 @@ nav:
- Quick Start: getting_started/quick_start.md - Quick Start: getting_started/quick_start.md
- Installation and Usage: getting_started/installation_and_usage.md - Installation and Usage: getting_started/installation_and_usage.md
- FAQ: getting_started/faq.md - FAQ: getting_started/faq.md
- Blog:
- blog/index.md
- User's Guide: - User's Guide:
- Terms and Definitions: users_guide/terms_and_definitions.md - Terms and Definitions: users_guide/terms_and_definitions.md
- Framework Basics: - Framework Basics:
@ -150,14 +149,13 @@ nav:
- Extending the Library: users_guide/use_cases/extending_the_library.md - Extending the Library: users_guide/use_cases/extending_the_library.md
- Examples: - Examples:
- Tags Index: users_guide/examples/tags_index.md - Tags Index: users_guide/examples/tags_index.md
- hello_units: users_guide/examples/hello_units.md - All Examples:
- avg_speed: users_guide/examples/avg_speed.md - hello_units: users_guide/examples/hello_units.md
- si_constants: users_guide/examples/si_constants.md - avg_speed: users_guide/examples/avg_speed.md
- Library Reference: - si_constants: users_guide/examples/si_constants.md
- Core Library: library_reference/core_library.md - Appendix:
- Magnitudes: library_reference/magnitudes.md - Glossary: appendix/glossary.md
- Appendix: - References: appendix/references.md
- Glossary: appendix/glossary.md - Blog:
- Mismeasure for Measure: appendix/mismeasure_for_measure.md - blog/index.md
- Release Notes: appendix/release_notes.md - Release Notes: release_notes.md
- References: appendix/references.md