Skip to content

Commit

Permalink
Configure Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
widoz committed Feb 24, 2024
1 parent 73dfad1 commit 92f0fd1
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 9 deletions.
5 changes: 4 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Api
---
title: Api
layout: post
---

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.

Expand Down
5 changes: 4 additions & 1 deletion docs/components.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Components
---
title: Components
layout: post
---

The Wp Entities Search provides a set of components you can use to build your search UI.

Expand Down
5 changes: 4 additions & 1 deletion docs/control-option.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Control Option
---
title: Control Option
layout: post
---

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.
Expand Down
5 changes: 4 additions & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Development
---
title: Development
layout: post
---

The first thing to do is to clone the repository and install the dependencies:

Expand Down
5 changes: 4 additions & 1 deletion docs/hooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Hooks
---
title: Hooks
layout: post
---

The Wp Entities Search expose some hooks to help you to work with the search and the rest calls.

Expand Down
5 changes: 4 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Installation
---
title: Installation
layout: post
---

This package is available as a composer library and as a npm package.

Expand Down
5 changes: 4 additions & 1 deletion docs/logging.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Logging
---
title: Logging
layout: post
---

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.
Expand Down
6 changes: 5 additions & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Wp Entities Search
---
layout: home
title: Wp Entities Search
permalink: /
---

This package is a library exposing reusable Components and Utilities to help you build Entities searching and storage.

Expand Down
5 changes: 4 additions & 1 deletion docs/storage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Storage
---
title: Storage
layout: post
---

You won't interact directly with the store but as mentioned in [hooks](./hooks.md), you can use the `useEntitiesOptionsStorage`.

Expand Down

0 comments on commit 92f0fd1

Please sign in to comment.