From 4676e16ff957cf1e7de41ea7491ffaab817c5225 Mon Sep 17 00:00:00 2001 From: Dan Connolly Date: Mon, 18 Mar 2024 22:52:54 -0500 Subject: [PATCH] docs: navigation for a path thru current docs --- main/.vitepress/config.mjs | 109 +++++++++++++++-------------- main/.vitepress/themeConfig/nav.js | 63 +++++++---------- 2 files changed, 81 insertions(+), 91 deletions(-) diff --git a/main/.vitepress/config.mjs b/main/.vitepress/config.mjs index 313fb15f6..996779373 100644 --- a/main/.vitepress/config.mjs +++ b/main/.vitepress/config.mjs @@ -118,14 +118,6 @@ export default defineConfig({ { text: 'Getting Started', link: '/guides/getting-started/', - collapsed: true, - items: [ - { text: 'Getting Started', link: '/guides/getting-started/' }, - { - text: 'Smart Wallet Dapp Architecture', - link: '/guides/getting-started/contract-rpc', - }, - ], }, { text: 'Zoe', @@ -142,14 +134,23 @@ export default defineConfig({ ], }, { - text: 'Agoric CLI', - link: '/guides/agoric-cli/', + text: 'ERTP', + link: '/guides/ertp/', collapsed: true, items: [ - { text: 'Agoric CLI Reference', link: '/guides/agoric-cli/' }, + { text: 'ERTP Overview', link: '/guides/ertp/' }, { - text: 'Using agd to make queries and transactions', - link: '/guides/agoric-cli/agd-query-tx', + text: 'Amounts, Values, and Brands', + link: '/guides/ertp/amounts', + }, + { text: 'AmountMath', link: '/guides/ertp/amount-math' }, + { + text: 'Issuers and Mints', + link: '/guides/ertp/issuers-and-mints', + }, + { + text: 'Purses and Payments', + link: '/guides/ertp/purses-and-payments', }, ], }, @@ -181,26 +182,20 @@ export default defineConfig({ ], }, { - text: 'ERTP', - link: '/guides/ertp/', + text: 'Agoric Platform', + link: '/guides/platform/', collapsed: true, - items: [ - { text: 'ERTP Overview', link: '/guides/ertp/' }, - { - text: 'Amounts, Values, and Brands', - link: '/guides/ertp/amounts', - }, - { text: 'AmountMath', link: '/guides/ertp/amount-math' }, - { - text: 'Issuers and Mints', - link: '/guides/ertp/issuers-and-mints', - }, - { - text: 'Purses and Payments', - link: '/guides/ertp/purses-and-payments', - }, - ], + items: [], + }, + { + text: 'Smart Wallet Dapp Architecture', + link: '/guides/getting-started/contract-rpc', + }, + { + text: 'Name Services: agoricNames, namesByAddress, board', + link: '/guides/integration/name-services', }, + { text: 'Permissioned Contract Deployment', link: '/guides/coreeval/', @@ -224,6 +219,21 @@ export default defineConfig({ }, ], }, + { + text: 'Deployed Zoe Contracts', + link: '/guides/zoe/actual-contracts/', + collapsed: true, + items: [ + { + text: 'Deployed Zoe Contracts', + link: '/guides/zoe/actual-contracts/', + }, + { + text: 'PSM Contract', + link: '/guides/zoe/actual-contracts/PSM', + }, + ], + }, { text: 'Example Zoe Contracts', link: '/guides/zoe/contracts/', @@ -302,29 +312,8 @@ export default defineConfig({ ], }, { - text: 'Deployed Zoe Contracts', - link: '/guides/zoe/actual-contracts/', - collapsed: true, - items: [ - { - text: 'Deployed Zoe Contracts', - link: '/guides/zoe/actual-contracts/', - }, - { - text: 'PSM Contract', - link: '/guides/zoe/actual-contracts/PSM', - }, - ], - }, - { - text: 'Smart Wallet Dapp Architecture', - link: '/guides/getting-started/contract-rpc', - }, - { - text: 'Agoric Platform', - link: '/guides/platform/', - collapsed: true, - items: [], + text: 'Integrating with Agoric Network', + link: '/guides/integration/chain-integration', }, { text: 'SubQuery Indexing', @@ -334,6 +323,18 @@ export default defineConfig({ }, ], '/reference/': [ + { + text: 'Agoric CLI', + link: '/guides/agoric-cli/', + collapsed: true, + items: [ + { text: 'Agoric CLI Reference', link: '/guides/agoric-cli/' }, + { + text: 'Using agd to make queries and transactions', + link: '/guides/agoric-cli/agd-query-tx', + }, + ], + }, { text: 'ERTP API', link: '/reference/ertp-api/', diff --git a/main/.vitepress/themeConfig/nav.js b/main/.vitepress/themeConfig/nav.js index 0bccd6899..ef6cf2a05 100644 --- a/main/.vitepress/themeConfig/nav.js +++ b/main/.vitepress/themeConfig/nav.js @@ -8,38 +8,12 @@ export const nav = [ { text: 'Getting Started', ariaLabel: 'Getting Started Menu', - items: [ - { - text: 'Your First Agoric Dapp', - ariaLabel: 'Your First Agoric Dapp Menu', - link: '/guides/getting-started/', - }, - { - text: 'Smart Wallet Dapp Architecture', - ariaLabel: 'Smart Wallet Dapp Architecture Menu', - link: '/guides/getting-started/contract-rpc', - }, - { - text: 'Permissioned Contract Deployment', - ariaLabel: 'Permissioned Contract Deployment', - link: '/guides/coreeval/', - }, - ], + link: '/guides/getting-started/', }, { text: 'Agoric Components', ariaLabel: 'Agoric Components Menu', items: [ - { - text: 'Agoric CLI', - ariaLabel: 'Agoric CLI', - link: '/guides/agoric-cli/', - }, - { - text: 'JavaScript Framework', - ariaLabel: 'JavaScript Framework', - link: '/guides/js-programming/', - }, { text: 'ERTP', ariaLabel: 'ERTP', @@ -50,6 +24,11 @@ export const nav = [ ariaLabel: 'Zoe', link: '/guides/zoe/', }, + { + text: 'Smart Wallet Dapp Architecture', + ariaLabel: 'Smart Wallet Dapp Architecture Menu', + link: '/guides/getting-started/contract-rpc', + }, { text: 'Example Zoe Contracts', ariaLabel: 'Example Zoe Contracts', @@ -61,16 +40,31 @@ export const nav = [ link: '/guides/zoe/actual-contracts/', }, { - text: 'Smart Wallet Dapp Architecture', - ariaLabel: 'Smart Wallet Dapp Architecture Menu', - link: '/guides/getting-started/contract-rpc', + text: 'Permissioned Contract Deployment', + ariaLabel: 'Permissioned Contract Deployment', + link: '/guides/coreeval/', + }, + { + text: 'JavaScript Framework', + ariaLabel: 'JavaScript Framework', + link: '/guides/js-programming/', }, ], }, { - text: 'API Reference', - ariaLabel: 'API Reference Menu', + text: 'Reference', + ariaLabel: 'Reference Menu', items: [ + { + text: 'Glossary', + ariaLabel: 'Glossary Menu', + link: '/glossary/', + }, + { + text: 'Agoric CLI', + ariaLabel: 'Agoric CLI', + link: '/guides/agoric-cli/', + }, { text: 'ERTP API', ariaLabel: 'ERTP API Menu', @@ -83,11 +77,6 @@ export const nav = [ }, ], }, - { - text: 'Glossary', - ariaLabel: 'Glossary Menu', - link: '/glossary/', - }, { text: 'New Features', ariaLabel: 'New Features Menu',