Skip to content

Commit

Permalink
Add configuration for versioned only site
Browse files Browse the repository at this point in the history
  • Loading branch information
@gbarros
gbarros committed Aug 9, 2024
1 parent 75d8554 commit 3681ceb
Show file tree
Hide file tree
Showing 3 changed files with 213 additions and 8 deletions.
204 changes: 204 additions & 0 deletions cartesi-rollups_versioned_sidebars/version-1.5-sidebars.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
{
"rollups": [
{
"type": "doc",
"id": "overview",
"label": "Overview"
},
{
"type": "doc",
"id": "quickstart",
"label": "Quickstart"
},
{
"type": "category",
"label": "Core Concepts",
"collapsed": true,
"items": [
"core-concepts/optimistic-rollups",
"core-concepts/architecture",
"core-concepts/mainnet-considerations"
]
},
{
"type": "category",
"label": "Rollups APIs",
"collapsed": true,
"items": [
"rollups-apis/http-api",
{
"type": "category",
"label": "Backend APIs",
"collapsed": true,
"items": [
"rollups-apis/backend/introduction",
"rollups-apis/backend/notices",
"rollups-apis/backend/vouchers",
"rollups-apis/backend/reports"
]
},
{
"type": "category",
"label": "Frontend APIs",
"collapsed": true,
"items": [
{
"type": "category",
"label": "Smart contracts API",
"collapsed": true,
"items": [
"rollups-apis/json-rpc/overview",
"rollups-apis/json-rpc/input-box",
"rollups-apis/json-rpc/application",
"rollups-apis/json-rpc/application-factory",
{
"type": "category",
"label": "Portals",
"collapsed": true,
"items": [
"rollups-apis/json-rpc/portals/ERC20Portal",
"rollups-apis/json-rpc/portals/ERC721Portal",
"rollups-apis/json-rpc/portals/ERC1155SinglePortal",
"rollups-apis/json-rpc/portals/ERC1155BatchPortal",
"rollups-apis/json-rpc/portals/EtherPortal"
]
},
{
"type": "category",
"label": "Relayer",
"collapsed": true,
"items": [
"rollups-apis/json-rpc/relays/relays"
]
}
]
},
{
"type": "category",
"label": "GraphQL API",
"collapsed": true,
"items": [
"rollups-apis/graphql/overview",
{
"type": "category",
"label": "Queries",
"collapsed": true,
"items": [
{
"type": "autogenerated",
"dirName": "rollups-apis/graphql/queries"
}
]
},
{
"type": "category",
"label": "Objects",
"collapsed": true,
"items": [
{
"type": "autogenerated",
"dirName": "rollups-apis/graphql/objects"
}
]
},
{
"type": "category",
"label": "Filters",
"collapsed": true,
"items": [
{
"type": "autogenerated",
"dirName": "rollups-apis/graphql/inputs"
}
]
}
]
}
]
}
]
},
{
"type": "category",
"label": "Development",
"collapsed": true,
"items": [
"development/installation",
"development/creating-application",
"development/building-the-application",
"development/running-the-application",
"development/cli-commands",
"development/send-requests",
"development/retrieve-outputs",
"development/asset-handling",
"development/migration",
"development/community-tools"
]
},
{
"type": "category",
"label": "Deployment",
"collapsed": true,
"items": [
"deployment/introduction",
"deployment/self-hosted"
]
},
{
"type": "category",
"label": "Tutorials",
"collapsed": true,
"items": [
"tutorials/calculator",
"tutorials/ether-wallet",
"tutorials/erc-20-token-wallet",
"tutorials/erc-721-token-wallet",
"tutorials/react-frontend-application"
]
},
{
"type": "category",
"label": "References",
"collapsed": true,
"items": [
{
"type": "category",
"label": "Releases",
"items": [
{
"type": "link",
"label": "Cartesi CLI",
"href": "https://github.com/cartesi/cli/releases"
},
{
"type": "link",
"label": "Rollups Node",
"href": "https://github.com/cartesi/rollups-node/releases"
},
{
"type": "link",
"label": "Rollups Contracts",
"href": "https://github.com/cartesi/rollups-contracts/releases"
}
]
},
{
"type": "category",
"label": "Changelog",
"items": [
{
"type": "link",
"label": "Rollups Node",
"href": "https://github.com/cartesi/rollups-node/blob/main/CHANGELOG.md"
},
{
"type": "link",
"label": "Rollups Contracts",
"href": "https://github.com/cartesi/rollups-contracts/blob/main/CHANGELOG.md"
}
]
}
]
}
]
}
1 change: 1 addition & 0 deletions cartesi-rollups_versions.json
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[
"1.5",
"1.3",
"1.0",
"0.9",
Expand Down
16 changes: 8 additions & 8 deletions docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,12 +339,12 @@ const config = {
id: "cartesi-rollups",
path: "cartesi-rollups",
routeBasePath: "cartesi-rollups",
sidebarPath: require.resolve("./sidebarsRollups.js"),
// sidebarPath: require.resolve("./sidebarsRollups.js"),
editUrl: "https://github.com/cartesi/docs/tree/main",
docLayoutComponent: "@theme/DocPage",
docItemComponent: "@theme/ApiItem",
includeCurrentVersion: true,
lastVersion: "current",
includeCurrentVersion: false,
lastVersion: "1.5",
admonitions: {
keywords: [
"note",
Expand All @@ -357,7 +357,7 @@ const config = {
],
},
versions: {
current: {
"1.5": {
label: "1.5",
path: "1.5",
},
Expand Down Expand Up @@ -513,15 +513,15 @@ const config = {
config: {
backEndApi: {
// Note: petstore key is treated as the <id> and can be used to specify an API doc instance when using CLI commands
specPath: "cartesi-rollups/rollups-apis/rollup.yaml", // Path to designated spec file
outputDir: "cartesi-rollups/rollups-apis/rollup", // Output directory for generated .mdx docs
specPath: "cartesi-rollups_versioned_docs/version-1.5/rollups-apis/rollup.yaml", // Path to designated spec file
outputDir: "cartesi-rollups_versioned_docs/version-1.5/rollups-apis/rollup", // Output directory for generated .mdx docs
sidebarOptions: {
groupPathsBy: "tag",
},
},
frontEndApi: {
specPath: "cartesi-rollups/rollups-apis/inspect.yaml",
outputDir: "cartesi-rollups/rollups-apis/inspect",
specPath: "cartesi-rollups_versioned_docs/version-1.5/rollups-apis/inspect.yaml",
outputDir: "cartesi-rollups_versioned_docs/version-1.5/rollups-apis/inspect",
},
},
},
Expand Down

0 comments on commit 3681ceb

Please sign in to comment.