Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

Commit

Permalink
Replace original bridge Markdown files with default OpenAPI RPC MDX f…
Browse files Browse the repository at this point in the history
…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
Show file tree
Hide file tree
Showing 17 changed files with 134 additions and 1,536 deletions.
9 changes: 9 additions & 0 deletions docs/references/json-rpc/admin/README.md
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
```
16 changes: 16 additions & 0 deletions docs/references/json-rpc/admin/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/debug/sidebar.ts
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;
633 changes: 0 additions & 633 deletions docs/references/json-rpc/debug/tracing.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/references/json-rpc/eth/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/governance/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/klay/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/mainbridge/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/net/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/personal/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/subbridge/sidebar.ts
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;
12 changes: 12 additions & 0 deletions docs/references/json-rpc/txpool/sidebar.ts
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;
180 changes: 0 additions & 180 deletions docs/references/service-chain-api/mainbridge.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/references/service-chain-api/service-chain-api.md

This file was deleted.

Loading

0 comments on commit 1c19a36

Please sign in to comment.