Skip to content

Commit aa344fc

Browse files
committed
fixed images and added alt text. destructures props and mdx file appropriately.
1 parent 5cd4d0d commit aa344fc

File tree

11 files changed

+16
-12
lines changed

11 files changed

+16
-12
lines changed

src/pages/docs/how-to/basic-setup/images/headless-admin-secret-1024x743.png renamed to src/pages/docs/how-to/basic-setup/images/headless-admin-secret.png

File renamed without changes.

src/pages/docs/how-to/basic-setup/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ Replace `https://faustexample.wpengine.com` with the URL for your WordPress back
3232

3333
Replace `YOUR_PLUGIN_SECRET` with the Secret Key found in `Settings → Faust` in your WordPress admin area.
3434

35-
![](./images/headless-admin-secret-1024x743.png)
35+
![Screenshot of the Headless Settings page in the WordPress admin panel, showing the Faust plugin settings. The Secret Key field is highlighted, which is required to enable authentication features like post previews in Faust.js.
36+
](./images/headless-admin-secret.png)
3637

3738
Save your `.env.local` file.
3839

src/pages/docs/how-to/generate-types-with-graphql-codegen/index.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,13 @@ export const pageQuery = gql(/* GraphQL */ `
101101

102102
Then you can inspect all the types in the `props` parameters as you type:
103103

104-
![](./images/ts-image-one.png)
104+
![TypeScript auto-complete suggestion in Faust.js, showing the available fields for a GraphQL query's response. The code completion suggests properties like `__SEED_NODE__`, `data`, and `loading`, indicating TypeScript's type inference for the `props` object.
105+
](./images/ts-image-one.png)
105106

106107
All the data from the query results will be properly typed based on the introspected schema:
107108

108-
![](./images/ts-image-two.png)
109+
![TypeScript type definition for an author field in a Faust.js GraphQL query. The type structure shows `NodeWithAuthorToUserConnectionEdge`, defining the `User` type with an optional `name` property, demonstrating TypeScript's type safety for GraphQL responses.
110+
](./images/ts-image-two.png)
109111

110112
### B. Typing Block Components
111113

src/pages/docs/how-to/post-previews/images/post-preview-frontend-1024x806-1.png renamed to src/pages/docs/how-to/post-previews/images/post-preview-frontend.png

File renamed without changes.

src/pages/docs/how-to/post-previews/images/post-preview-1024x806-1.png renamed to src/pages/docs/how-to/post-previews/images/post-preview.png

File renamed without changes.

src/pages/docs/how-to/post-previews/index.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,11 @@ Start by logging into your WordPress Admin. For this example, we'll create a new
112112
113113
So far, I've added a title and a simple line of text for the content. To view this post as a preview on your front end, click the `Preview` link (1). From there, click, `Preview in new tab` (2):
114114
115-
![](./images/post-preview-1024x806-1.png)
115+
![WordPress editor with a draft post titled 'My Post' and a simple text block for post content. The Preview dropdown menu is open, showing options to preview the post on Desktop, Tablet, and Mobile, along with a 'Preview in new tab' option highlighted.
116+
](./images/post-preview.png)
116117
117118
Notice that the `Publish` button is also visible, meaning that you still need to publish the post. Therefore, you can now view the post on the frontend without being authenticated.
118119
119120
Clicking on `Preview in new tab` should take you to your post preview page with the current preview content:
120121
121-
![](./images/post-preview-frontend-1024x806-1.png)
122+
![Frontend preview of a WordPress post in a Faust.js headless setup. The page displays 'My Post' as the title with preview content below. The preview URL includes `?preview=true`, indicating that the user is viewing an unpublished draft.](./images/post-preview-frontend.png)

src/pages/docs/how-to/rendering-blocks/images/Screenshot-2024-10-08-at-10.10.31-AM.png renamed to src/pages/docs/how-to/rendering-blocks/images/graphqlide-block.png

File renamed without changes.

src/pages/docs/how-to/rendering-blocks/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Once the plugin is installed and activated, head over to the GraphQL IDE. You ca
2626

2727
You should be able to perform queries for the block data. There is a new field added in the Post and Page models called `editorBlocks`. This represents a list of available blocks for that content type:
2828

29-
![](images/Screenshot-2024-10-08-at-10.10.31-AM.png)
29+
![GraphQL IDE interface showing a WPGraphQL query fetching post block data. The query requests `editorBlocks` fields, including `name` and `renderedHtml`, while the response displays structured JSON data containing block names and their corresponding rendered HTML content.](images/graphqlide-block.png)
3030

3131
If you search in GraphQL IDE documentation explorer tab for the `editorBlocks` type you will be able to see the available block fields. The most important ones are:
3232

src/pages/docs/how-to/sitemaps/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Ensure that you have completed the steps in the following pages before proceedin
1515
1. In your WordPress Admin, go to **Settings > Reading**.
1616
2. Uncheck the **Search Engine Visibility** box.
1717

18-
![](./images/reading-settings.png)
18+
![WordPress Reading Settings screen displaying options for feed content inclusion and search engine visibility. The 'Discourage search engines from indexing this site' checkbox is unchecked, ensuring the site is visible to search engines.](./images/reading-settings.png)
1919

2020
## 2. Create `sitemap.xml.js`
2121

-50.4 KB
Loading

0 commit comments

Comments
 (0)