Skip to content

Commit

Permalink
Fix minor documentation errors (#219)
Browse files Browse the repository at this point in the history
* Fix missing parenthesis
* Fix docs links to "extending" secton from core concepts
* Remove unfilled [image tk] in documentation
  • Loading branch information
alecgeatches authored Nov 26, 2024
1 parent 0c5f7e3 commit d73c623
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
10 changes: 4 additions & 6 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,21 @@ Remote Data Blocks allows you to integrate remote data into posts, pages, patter

## Remote data

**Remote data** refers to data that is fetched from an external source, such as an API or a third-party service. This might be a product in your Shopify store, data in an Airtable or Google Sheet, or a file in a GitHub repository. Remote data is usually fetched via HTTP requests but you can [extend the plugin](extending.md) to support other transports.
**Remote data** refers to data that is fetched from an external source, such as an API or a third-party service. This might be a product in your Shopify store, data in an Airtable or Google Sheet, or a file in a GitHub repository. Remote data is usually fetched via HTTP requests but you can [extend the plugin](../extending/index.md) to support other transports.

## Remote data block

A **remote data block** is a custom block that fetches and displays data from a specific remote source. Each remote data block has a unique name and provides a specific kind of data.

For example, you might have a remote data block named "Shopify Product" that fetches a product from your Shopify store and displays the product's name, description, price, and image. Or, you might have a remote data block named "Conference event" that displays rows from an Airtable and displays the event's name, location, and type. It might look something like this:

[image tk]
For example, you might have a remote data block named "Shopify Product" that fetches a product from your Shopify store and displays the product's name, description, price, and image. Or, you might have a remote data block named "Conference event" that displays rows from an Airtable and displays the event's name, location, and type.

Remote data blocks are **container blocks** that contain other blocks and provide remote data to them. You retain full control over the layout, design, and content. You can leverage patterns to enable consistent styling and workflows, and you can customize the block's appearance using the block editor or `theme.json`.

Remote data blocks are custom blocks, but they are created and registered by our plugin and don't require custom block development. Remote data is loaded via [the block bindings API](https://make.wordpress.org/core/2024/03/06/new-feature-the-block-bindings-api/).

## Data sources and queries

Each remote data block is associated with a **data source** and a **query** that defines how data is fetched, processed, and displayed. Simple data sources and queries can be configured via the plugin's settings screen, while others may require custom PHP code (see [extending](extending.md)).
Each remote data block is associated with a **data source** and a **query** that defines how data is fetched, processed, and displayed. Simple data sources and queries can be configured via the plugin's settings screen, while others may require custom PHP code (see [extending](../extending/index.md)).

## Data fetching

Expand All @@ -42,4 +40,4 @@ Since remote data blocks are container blocks, you can use patterns to create re

## Technical concepts

If you're a developer and want to understand the internals of Remote Data Blocks so that you can extend its functionality, head over the [extending guide](extending.md).
If you're a developer and want to understand the internals of Remote Data Blocks so that you can extend its functionality, head over the [extending guide](../extending/index.md).
2 changes: 1 addition & 1 deletion docs/extending/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Once you've defined your custom classes, you can [register a remote data block](
### Additional customization

- [Block patterns](block-patterns.md)
- [Hooks (actions and filters](hooks.md)
- [Hooks (actions and filters)](hooks.md)

## Workflows

Expand Down

0 comments on commit d73c623

Please sign in to comment.