Skip to content

Commit f998670

Browse files
committed
Align documentation
1 parent 2da8c60 commit f998670

4 files changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ On a feed list you can find:
3232
* **In Process - generation is currently in progress**
3333
* **Generated - Feed it ready to be used**
3434

35+
If during feed generation an error occurs, you can see an error in the grid.
36+
37+
![Feed Generation Error](./docs/images/feed-error.png)
38+
3539
## Edit Feed
3640

3741
On a Grid page you can click on a Feed name, and you will be landed on Edit page of selected feed:
@@ -96,6 +100,13 @@ Based on this GQL schema you can use the following variables (starting inside of
96100

97101
… and so on depends on a schema used
98102

103+
## Settings
104+
105+
GraphQL schema loaded from Adobe Commerce is cached by the module. So if you change schema on Adobe Commerce side, you have to update the cache.
106+
For that go to Settings and click on clean the cache button.
107+
108+
![Settings](./docs/images/feed-settings.png)
109+
99110
### Placeholders
100111

101112
#### Fixed Variables

docs/images/feeder-error.png

73 KB
Loading

docs/images/feeder-settings.png

19.2 KB
Loading

web-src/src/component/Docs.js

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@ import React, { useEffect } from 'react';
22

33
function Docs() {
44
useEffect(() => {
5-
window.open("https://spectrum.adobe.com/", "_blank", "noopener,noreferrer");
5+
window.open("https://github.com/comwrap/adobe-commerce-feed-generator-app-builder/blob/main/README.md", "_blank", "noopener,noreferrer");
66
}, []);
77

8-
return null; // No UI is rendered
8+
9+
return (
10+
<div>
11+
<a href="https://github.com/comwrap/adobe-commerce-feed-generator-app-builder/blob/main/README.md" target="_blank" rel="noopener noreferrer">
12+
<h1>Documentation</h1>
13+
</a>
14+
</div>
15+
); // No UI is rendered
916
}
1017

1118
export default Docs;

0 commit comments

Comments
 (0)