Skip to content

Commit 956f9db

Browse files
refactor sidebars
1 parent 7ebbe75 commit 956f9db

File tree

5 files changed

+10
-18
lines changed

5 files changed

+10
-18
lines changed

docs/api/xChainRead/api-reference.md renamed to docs/integration/xChainRead/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: api-reference
33
title: API Reference
44
sidebar_label: API Reference
5-
sidebar_position: 1
5+
sidebar_position: 2
66
---
77

88
# API Reference
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
id: frontend
3-
title: Frontend Integration
4-
sidebar_label: Frontend Integration
5-
sidebar_position: 2
3+
title: ERC 7683 Frontend Integration
4+
sidebar_label: ERC 7683 Frontend Integration
5+
sidebar_position: 3
66
---
77

88
# Frontend Integration for 7683 Intent Bridging
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: xChainRead
2+
id: overview
33
title: xChainRead Overview
4-
sidebar_label: xChainRead
4+
sidebar_label: Overview
55
sidebar_position: 1
66
---
77

@@ -92,8 +92,8 @@ The `requestRead` function is used to request a cross-chain read. It takes a `Re
9292

9393
### 3. Handle Proof Response
9494

95-
Once the read request is processed, the result will be posted to the [API](../../api/xChainRead/api-reference). You can fetch the proof from the API and verify it with your contract. The `verifyProofOfRead` function is used to verify the proof. It takes a `bytes` calldata as input, which can be fetched via the `handle_read_result_with_proof_calldata` field from the API. If the proof is valid, the function will return the request ID and the result of the target function. If the proof is invalid, the function will revert.
95+
Once the read request is processed, the result will be posted to the [API](../xChainRead/api-reference). You can fetch the proof from the API and verify it with your contract. The `verifyProofOfRead` function is used to verify the proof. It takes a `bytes` calldata as input, which can be fetched via the `handle_read_result_with_proof_calldata` field from the API. If the proof is valid, the function will return the request ID and the result of the target function. If the proof is invalid, the function will revert.
9696

9797
## Next Steps
9898

99-
- [API Reference](../../api/xChainRead/api-reference) - Detailed API documentation
99+
- [API Reference](../xChainRead/api-reference) - Detailed API documentation

docusaurus.config.js

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ require('dotenv').config()
55
module.exports = {
66
customFields: {
77
// Analytics proxy URL
8-
analyticsProxyUrl: process.env.REACT_APP_AMPLITUDE_PROXY_URL,
8+
// analyticsProxyUrl: process.env.REACT_APP_AMPLITUDE_PROXY_URL,
99
// Determines if staging env
1010
stagingEnv: process.env.REACT_APP_STAGING,
1111
// From node
@@ -36,18 +36,11 @@ module.exports = {
3636
className: 'V3_active',
3737
},
3838
{
39-
to: '/integration/7683/xChainRead',
39+
to: '/integration/xChainRead/overview',
4040
label: 'Integration',
4141
position: 'left',
4242
className: 'V3_active',
4343
},
44-
{
45-
to: '/api/xChainRead/api-reference',
46-
label: 'API',
47-
position: 'left',
48-
className: 'V3_active',
49-
},
50-
5144
{
5245
// TODO(docs): Publish docs repo and make public at this URL
5346
href: 'https://github.com/t1protocol/',

sidebars.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
22
const sidebars = {
33
// By default, Docusaurus generates a sidebar from the docs folder structure
4-
apiSidebar: [{ type: 'autogenerated', dirName: 'api' }],
54
integrationSidebar: [{ type: 'autogenerated', dirName: 'integration' }],
65
conceptsSidebar: [{ type: 'autogenerated', dirName: 'concepts' }],
76
contractsSidebar: [{ type: 'autogenerated', dirName: 'contracts' }],

0 commit comments

Comments
 (0)