Last Adjustements

Spaghetti-Dojo · Feb 24, 2024 · c001938 · c001938
1 parent a04e45e
commit c001938
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 1
 ---
 
+# Api
+
 The `api` define a `fetch` function which is there to hide the WordPress Fetch API. The reason behind this decision lies on the fact that we might want to add middlewares to the request in the future or introducing some global data manipulation.
 
 The package provide then the following functions to interact with the WordPress API:

diff --git a/docs/components.md b/docs/components.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 2
 ---
 
+# Components
+
 The Wp Entities Search provides a set of components you can use to build your search UI.
 
 We have to distinguish between two types of components:

diff --git a/docs/control-option.md b/docs/control-option.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 3
 ---
 
+# Control Option
+
 The `ControlOption` is the core Value Object of the project. It holds the information about the entities, and it
 is carried around the business logic and the presentational layer.
 

diff --git a/docs/development.md b/docs/development.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 4
 ---
 
+# Development
+
 The first thing to do is to clone the repository and install the dependencies:
 
 ```bash

diff --git a/docs/hooks.md b/docs/hooks.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 5
 ---
 
+# Hooks
+
 The Wp Entities Search expose some hooks to help you to work with the search and the rest calls.
 
 - `useEntitiesOptionsStorage`

diff --git a/docs/installation.md b/docs/installation.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 6
 ---
 
+# Installation
+
 This package is available as a composer library and as a npm package.
 
 You're not forced to use both, you can use only one of them. The php implementation is using [Modularity](https://github.com/inpsyde/modularity) a modular [PSR-11](https://github.com/php-fig/container) implementation for WordPress Plugins, Themes and Libraries.

diff --git a/docs/logging.md b/docs/logging.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 7
 ---
 
+# Logging
+
 The project make use of some WordPress Actions in contexts where the logic flow might fail for some reason, for instance
 when there's a REST request that fails to be processed. In these cases, the project will fire an action.
 

diff --git a/docs/readme.md b/docs/readme.md
@@ -2,6 +2,7 @@
 layout: home
 title: Wp Entities Search
 permalink: /
+nav_order: 0
 ---
 
 This package is a library exposing reusable Components and Utilities to help you build Entities searching and storage.

diff --git a/docs/storage.md b/docs/storage.md
@@ -4,6 +4,8 @@ layout: post
 nav_order: 8
 ---
 
+# Storage
+
 You won't interact directly with the store but as mentioned in [hooks](./hooks.md), you can use the `useEntitiesOptionsStorage`.
 
 The hook return the `state` and the `dispatch` but you have to configure it first.
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ layout: post @@
     nav_order: 1
     ---
+    # Api
     The `api` define a `fetch` function which is there to hide the WordPress Fetch API. The reason behind this decision lies on the fact that we might want to add middlewares to the request in the future or introducing some global data manipulation.
     The package provide then the following functions to interact with the WordPress API:
@@ Expand Down @@