Skip to content

Commit 48eda1d

Browse files
modihsraham
andauthored
refactor: move contracts under Build > API, merge manuals into guides (#121)
- Move docs/contracts/ to docs/build/api/contracts/ with Deployed Addresses as the section index (skip vendor README) - Merge docs/manuals/ into docs/guides/manuals/ - Remove Contracts and Manuals navbar links - Remove contractsSidebar and manualsSidebar - Update sync-contracts-docs.js output path and sidebar references - Update homepage and supported-chains links <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized API documentation structure for improved discoverability within the Build section. * Relocated Manuals content to the Guides section. * Updated documentation navigation and sidebar hierarchy. * Simplified overall documentation layout and cross-references. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Maharshi Mishra <ihsraham27@gmail.com>
1 parent 5ed6c1b commit 48eda1d

48 files changed

Lines changed: 122 additions & 329 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/build/api/_category_.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "API",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index"
6+
},
7+
"collapsible": false,
8+
"collapsed": false
9+
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Contracts",
3+
"position": 1,
4+
"link": {
5+
"type": "doc",
6+
"id": "build/api/contracts/index"
7+
},
8+
"collapsible": false,
9+
"collapsed": false
10+
}
File renamed without changes.

docs/contracts/api-reference/app-registry.md renamed to docs/build/api/contracts/api-reference/app-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "AppRegistry"
33
description: "App builder registry with slashing."
44
sidebar_position: 4
5-
displayed_sidebar: contractsSidebar
5+
displayed_sidebar: buildSidebar
66
---
77

88
# AppRegistry

docs/contracts/api-reference/faucet.md renamed to docs/build/api/contracts/api-reference/faucet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Faucet"
33
description: "Testnet token faucet."
44
sidebar_position: 7
5-
displayed_sidebar: contractsSidebar
5+
displayed_sidebar: buildSidebar
66
---
77

88
# Faucet

docs/contracts/api-reference/interfaces/_category_.json renamed to docs/build/api/contracts/api-reference/interfaces/_category_.json

File renamed without changes.

docs/contracts/api-reference/interfaces/ilock.md renamed to docs/build/api/contracts/api-reference/interfaces/ilock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "ILock"
33
description: "Lock/unlock/withdraw interface."
44
sidebar_position: 1
5-
displayed_sidebar: contractsSidebar
5+
displayed_sidebar: buildSidebar
66
---
77

88
# ILock

docs/contracts/api-reference/interfaces/islash.md renamed to docs/build/api/contracts/api-reference/interfaces/islash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "ISlash"
33
description: "Slashing interface."
44
sidebar_position: 2
5-
displayed_sidebar: contractsSidebar
5+
displayed_sidebar: buildSidebar
66
---
77

88
# ISlash

docs/contracts/api-reference/locker.md renamed to docs/build/api/contracts/api-reference/locker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Locker"
33
description: "Abstract lock/unlock/withdraw state machine."
44
sidebar_position: 2
5-
displayed_sidebar: contractsSidebar
5+
displayed_sidebar: buildSidebar
66
---
77

88
# Locker

docs/contracts/api-reference/node-registry.md renamed to docs/build/api/contracts/api-reference/node-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "NodeRegistry"
33
description: "Node operator registry with voting power."
44
sidebar_position: 3
5-
displayed_sidebar: contractsSidebar
5+
displayed_sidebar: buildSidebar
66
---
77

88
# NodeRegistry

0 commit comments

Comments
 (0)