Skip to content

Commit

Permalink
Adjust docs to better span web/repo display (#37)
Browse files Browse the repository at this point in the history
* adjust

* rename
  • Loading branch information
mhsdef authored Sep 10, 2024
1 parent 64550ea commit 50dd987
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ Remote Data Blocks is a WordPress plugin that brings an assortment of flexible,

6. Use the blocks to display dynamic content from various sources directly in your posts or pages.

Developers! You can [extend](docs/extending.md) the plugin by creating new datasources and queries.
_Developers! You can [extend](https://github.com/Automattic/remote-data-blocks/blob/trunk/docs/extending.md) the plugin by creating new datasources and queries._
2 changes: 1 addition & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Remote Data Blocks: Core Concepts
# Core Concepts

Remote Data Blocks is a WordPress plugin that enhances the Gutenberg editor by providing flexible, data-enrichable blocks. These blocks allow authors to seamlessly integrate local WordPress data, remote data, and custom layouts within the block editor.

Expand Down
10 changes: 5 additions & 5 deletions docs/extending.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Remote Data Blocks: Extending the Plugin
# Extending

Remote Data Blocks is designed to be extensible, allowing developers to create new data sources and queries. This guide will walk you through the process of extending the core plugin.

## 1. Creating a New Data Source
## 1. Create a New Data Source

To create a new data source:

Expand All @@ -23,7 +23,7 @@ class YourCustomDatasource extends HttpDatasource {
}
```

## 2. Creating a New Query
## 2. Create a New Query

To create a new query:

Expand All @@ -50,7 +50,7 @@ class YourCustomQuery extends QueryContext {
}
```

## 3. Registering Your New Block
## 3. Register Your New Block

To register your new block:

Expand All @@ -74,7 +74,7 @@ function register_your_custom_block() {
add_action( 'register_remote_data_blocks', 'YourNamespace\\register_your_custom_block' );
```

## 4. Creating Block Patterns
## 4. Create Block Patterns

Create HTML patterns for your block to define how the data should be displayed. Use the Remote Data Blocks binding syntax to connect data to your pattern.

Expand Down
8 changes: 2 additions & 6 deletions docs/data-flow.md → docs/how-it-works.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Remote Data Blocks: Data Flow
# How It Works

## Overview

This document outlines the data flow within the Remote Data Blocks WordPress plugin, explaining how data moves from external sources to the Gutenberg editor and finally to the frontend display.

## Data Flow Steps
At a high level, step by step, here is what is happening:

1. **Block Insertion**:

Expand Down

0 comments on commit 50dd987

Please sign in to comment.