Merge pull request #11 from mbarbin/diataxis

Rename doc section Explanation (diataxis)

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

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

doc/docs/design/README.md → 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.
 

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/',
  },
  ],
  },

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' },
  ],
  },
  ],