diff --git a/CHANGES.md b/CHANGES.md index 5cfa2ac..7bcaf93 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,17 @@ +## 0.0.10 (unreleased) + +### Added + +### Changed + +- Rename `explanation` section of documentation per diataxis. + +### Deprecated + +### Fixed + +### Removed + ## 0.0.9 (2024-08-26) ### Changed diff --git a/doc/blog/authors.yml b/doc/blog/authors.yml index 17251ad..e13b0ef 100644 --- a/doc/blog/authors.yml +++ b/doc/blog/authors.yml @@ -1,5 +1,5 @@ mbarbin: name: Mathieu Barbin - title: Maintainer of provider + title: Author & Maintainer of provider url: https://github.com/mbarbin image_url: https://github.com/mbarbin.png diff --git a/doc/docs/design/README.md b/doc/docs/explanation/README.md similarity index 82% rename from doc/docs/design/README.md rename to doc/docs/explanation/README.md index 98d2a7c..532c63e 100644 --- a/doc/docs/design/README.md +++ b/doc/docs/explanation/README.md @@ -1,4 +1,8 @@ -# Design +# Explanation + +Welcome to the Explanation section of the `provider` documentation. Here, we delve into the details of how `provider` works and its design principles. This section is intended to provide a deeper understanding of the project for developers and contributors. + +## Synopsis Provider is an OCaml library for creating Traits and Signatures to build upon some functionality needed by a library without committing to an actual implementation for it, until runtime. diff --git a/doc/docusaurus.config.ts b/doc/docusaurus.config.ts index 54f32d6..7eac438 100644 --- a/doc/docusaurus.config.ts +++ b/doc/docusaurus.config.ts @@ -91,9 +91,9 @@ const config: Config = { }, { type: 'docSidebar', - sidebarId: 'designSidebar', + sidebarId: 'explanationSidebar', position: 'left', - label: 'Design', + label: 'Explanation', }, { to: '/blog/', label: 'Blog', position: 'right' }, { @@ -128,8 +128,8 @@ const config: Config = { to: '/docs/reference/odoc/', }, { - label: 'Design', - to: '/docs/design/', + label: 'Explanation', + to: '/docs/explanation/', }, ], }, diff --git a/doc/sidebars.ts b/doc/sidebars.ts index a9a7879..dd2e401 100644 --- a/doc/sidebars.ts +++ b/doc/sidebars.ts @@ -44,12 +44,12 @@ const sidebars: SidebarsConfig = { }, ], - designSidebar: [ + explanationSidebar: [ { type: 'category', - label: 'Design', + label: 'Explanation', items: [ - { type: 'doc', id: 'design/README', label: 'Introduction' }, + { type: 'doc', id: 'explanation/README', label: 'Introduction' }, ], }, ],