This repository has been archived by the owner on Jun 4, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace original bridge Markdown files with default OpenAPI RPC MDX f…
…or local Klaytn-docs setup (#678) * Replace original bridge Markdown files with default OpenAPI RPC MDX for local Klaytn-docs setup * remove dummy files * control sidebar in local start * delete dummy openapi spec file
- Loading branch information
jack
authored
Mar 20, 2024
1 parent
5d514df
commit 1c19a36
Showing
17 changed files
with
134 additions
and
1,536 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
This RPC API docs will be automatically generated in the Klaytn-docs official site. | ||
Please follow the steps below if you also want to build the RPC API documentation | ||
```shell | ||
> git clone -b dev https://github.com/klaytn/web3klaytn.git | ||
|
||
> cd ./web3klaytn/documentation && RPC_SPEC_DIR=../../web3rpc/yaml ./generate-docs.sh split | ||
|
||
> cd ../../web3rpc && ./web3rpc.sh | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/admin/web-3-rpc", | ||
}, | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/admin/README", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/debug/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/eth/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/governance/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/klay/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/mainbridge/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/net/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/personal/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/subbridge/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; | ||
|
||
const sidebar: SidebarsConfig = { | ||
apisidebar: [ | ||
{ | ||
type: "doc", | ||
id: "references/json-rpc/txpool/web-3-rpc", | ||
}, | ||
], | ||
}; | ||
|
||
export default sidebar.apisidebar; |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.