From 8007b7605256ae39a9cf7cc1c8857e3b1607d7b1 Mon Sep 17 00:00:00 2001 From: Matej Vukosav Date: Wed, 3 Jul 2024 20:09:30 +0200 Subject: [PATCH] chore: extract and highlight getting started (#4) --- docs/01-explore/02-developers-quickstart/_category_.json | 3 --- .../01-setup.mdx} | 7 ++++--- .../02-admin-dashboard.mdx | 0 .../03-example-app.mdx | 0 .../_04-invite-to-context.mdx | 0 .../_admin-dashboard-ui.mdx | 0 docs/03-getting-started/_category_.json | 3 +++ .../_kv-store.mdx | 0 docs/{03-build => 04-build}/00-quickstart.mdx | 0 .../01-protocol-sdks/01-protocol-sdk.mdx | 0 .../01-protocol-sdks/02-protocol-rs-sdk.mdx | 0 .../01-protocol-sdks/_category_.json | 0 .../02-client-sdks/02-client-ts-sdk.mdx | 0 docs/{03-build => 04-build}/02-client-sdks/_category_.json | 0 docs/{03-build => 04-build}/03-publish-app.mdx | 0 docs/{03-build => 04-build}/_category_.json | 0 docs/{04-contribute => 05-contribute}/01-github.mdx | 0 docs/{04-contribute => 05-contribute}/02-hackathons.mdx | 0 .../{04-contribute => 05-contribute}/03-bounty-program.mdx | 0 docs/{04-contribute => 05-contribute}/_category_.json | 0 .../01-community-and-support.mdx | 0 docs/{05-resources => 06-resources}/02-learning.mdx | 0 docs/{05-resources => 06-resources}/_category_.json | 0 docusaurus.config.ts | 5 +++++ 24 files changed, 12 insertions(+), 6 deletions(-) delete mode 100644 docs/01-explore/02-developers-quickstart/_category_.json rename docs/{01-explore/02-developers-quickstart/01-getting-started.mdx => 03-getting-started/01-setup.mdx} (95%) rename docs/{01-explore/02-developers-quickstart => 03-getting-started}/02-admin-dashboard.mdx (100%) rename docs/{01-explore/02-developers-quickstart => 03-getting-started}/03-example-app.mdx (100%) rename docs/{01-explore/02-developers-quickstart => 03-getting-started}/_04-invite-to-context.mdx (100%) rename docs/{01-explore/02-developers-quickstart => 03-getting-started}/_admin-dashboard-ui.mdx (100%) create mode 100644 docs/03-getting-started/_category_.json rename docs/{01-explore/02-developers-quickstart => 03-getting-started}/_kv-store.mdx (100%) rename docs/{03-build => 04-build}/00-quickstart.mdx (100%) rename docs/{03-build => 04-build}/01-protocol-sdks/01-protocol-sdk.mdx (100%) rename docs/{03-build => 04-build}/01-protocol-sdks/02-protocol-rs-sdk.mdx (100%) rename docs/{03-build => 04-build}/01-protocol-sdks/_category_.json (100%) rename docs/{03-build => 04-build}/02-client-sdks/02-client-ts-sdk.mdx (100%) rename docs/{03-build => 04-build}/02-client-sdks/_category_.json (100%) rename docs/{03-build => 04-build}/03-publish-app.mdx (100%) rename docs/{03-build => 04-build}/_category_.json (100%) rename docs/{04-contribute => 05-contribute}/01-github.mdx (100%) rename docs/{04-contribute => 05-contribute}/02-hackathons.mdx (100%) rename docs/{04-contribute => 05-contribute}/03-bounty-program.mdx (100%) rename docs/{04-contribute => 05-contribute}/_category_.json (100%) rename docs/{05-resources => 06-resources}/01-community-and-support.mdx (100%) rename docs/{05-resources => 06-resources}/02-learning.mdx (100%) rename docs/{05-resources => 06-resources}/_category_.json (100%) diff --git a/docs/01-explore/02-developers-quickstart/_category_.json b/docs/01-explore/02-developers-quickstart/_category_.json deleted file mode 100644 index 440d633a..00000000 --- a/docs/01-explore/02-developers-quickstart/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Developers Quickstart" -} diff --git a/docs/01-explore/02-developers-quickstart/01-getting-started.mdx b/docs/03-getting-started/01-setup.mdx similarity index 95% rename from docs/01-explore/02-developers-quickstart/01-getting-started.mdx rename to docs/03-getting-started/01-setup.mdx index 95f29404..ee7546da 100644 --- a/docs/01-explore/02-developers-quickstart/01-getting-started.mdx +++ b/docs/03-getting-started/01-setup.mdx @@ -1,6 +1,6 @@ --- -id: getting-started -title: Getting started +id: setup +title: Setup --- Before you start, make sure you are familiar with [Calimero Terminology](/learn/terminology). @@ -10,7 +10,8 @@ Before you start, make sure you are familiar with [Calimero Terminology](/learn/ ### Prerequisites Clone repository from GitHub. -``` terminal + +```terminal git clone git@github.com:calimero-network/core.git ``` diff --git a/docs/01-explore/02-developers-quickstart/02-admin-dashboard.mdx b/docs/03-getting-started/02-admin-dashboard.mdx similarity index 100% rename from docs/01-explore/02-developers-quickstart/02-admin-dashboard.mdx rename to docs/03-getting-started/02-admin-dashboard.mdx diff --git a/docs/01-explore/02-developers-quickstart/03-example-app.mdx b/docs/03-getting-started/03-example-app.mdx similarity index 100% rename from docs/01-explore/02-developers-quickstart/03-example-app.mdx rename to docs/03-getting-started/03-example-app.mdx diff --git a/docs/01-explore/02-developers-quickstart/_04-invite-to-context.mdx b/docs/03-getting-started/_04-invite-to-context.mdx similarity index 100% rename from docs/01-explore/02-developers-quickstart/_04-invite-to-context.mdx rename to docs/03-getting-started/_04-invite-to-context.mdx diff --git a/docs/01-explore/02-developers-quickstart/_admin-dashboard-ui.mdx b/docs/03-getting-started/_admin-dashboard-ui.mdx similarity index 100% rename from docs/01-explore/02-developers-quickstart/_admin-dashboard-ui.mdx rename to docs/03-getting-started/_admin-dashboard-ui.mdx diff --git a/docs/03-getting-started/_category_.json b/docs/03-getting-started/_category_.json new file mode 100644 index 00000000..d331fe22 --- /dev/null +++ b/docs/03-getting-started/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Getting started" +} \ No newline at end of file diff --git a/docs/01-explore/02-developers-quickstart/_kv-store.mdx b/docs/03-getting-started/_kv-store.mdx similarity index 100% rename from docs/01-explore/02-developers-quickstart/_kv-store.mdx rename to docs/03-getting-started/_kv-store.mdx diff --git a/docs/03-build/00-quickstart.mdx b/docs/04-build/00-quickstart.mdx similarity index 100% rename from docs/03-build/00-quickstart.mdx rename to docs/04-build/00-quickstart.mdx diff --git a/docs/03-build/01-protocol-sdks/01-protocol-sdk.mdx b/docs/04-build/01-protocol-sdks/01-protocol-sdk.mdx similarity index 100% rename from docs/03-build/01-protocol-sdks/01-protocol-sdk.mdx rename to docs/04-build/01-protocol-sdks/01-protocol-sdk.mdx diff --git a/docs/03-build/01-protocol-sdks/02-protocol-rs-sdk.mdx b/docs/04-build/01-protocol-sdks/02-protocol-rs-sdk.mdx similarity index 100% rename from docs/03-build/01-protocol-sdks/02-protocol-rs-sdk.mdx rename to docs/04-build/01-protocol-sdks/02-protocol-rs-sdk.mdx diff --git a/docs/03-build/01-protocol-sdks/_category_.json b/docs/04-build/01-protocol-sdks/_category_.json similarity index 100% rename from docs/03-build/01-protocol-sdks/_category_.json rename to docs/04-build/01-protocol-sdks/_category_.json diff --git a/docs/03-build/02-client-sdks/02-client-ts-sdk.mdx b/docs/04-build/02-client-sdks/02-client-ts-sdk.mdx similarity index 100% rename from docs/03-build/02-client-sdks/02-client-ts-sdk.mdx rename to docs/04-build/02-client-sdks/02-client-ts-sdk.mdx diff --git a/docs/03-build/02-client-sdks/_category_.json b/docs/04-build/02-client-sdks/_category_.json similarity index 100% rename from docs/03-build/02-client-sdks/_category_.json rename to docs/04-build/02-client-sdks/_category_.json diff --git a/docs/03-build/03-publish-app.mdx b/docs/04-build/03-publish-app.mdx similarity index 100% rename from docs/03-build/03-publish-app.mdx rename to docs/04-build/03-publish-app.mdx diff --git a/docs/03-build/_category_.json b/docs/04-build/_category_.json similarity index 100% rename from docs/03-build/_category_.json rename to docs/04-build/_category_.json diff --git a/docs/04-contribute/01-github.mdx b/docs/05-contribute/01-github.mdx similarity index 100% rename from docs/04-contribute/01-github.mdx rename to docs/05-contribute/01-github.mdx diff --git a/docs/04-contribute/02-hackathons.mdx b/docs/05-contribute/02-hackathons.mdx similarity index 100% rename from docs/04-contribute/02-hackathons.mdx rename to docs/05-contribute/02-hackathons.mdx diff --git a/docs/04-contribute/03-bounty-program.mdx b/docs/05-contribute/03-bounty-program.mdx similarity index 100% rename from docs/04-contribute/03-bounty-program.mdx rename to docs/05-contribute/03-bounty-program.mdx diff --git a/docs/04-contribute/_category_.json b/docs/05-contribute/_category_.json similarity index 100% rename from docs/04-contribute/_category_.json rename to docs/05-contribute/_category_.json diff --git a/docs/05-resources/01-community-and-support.mdx b/docs/06-resources/01-community-and-support.mdx similarity index 100% rename from docs/05-resources/01-community-and-support.mdx rename to docs/06-resources/01-community-and-support.mdx diff --git a/docs/05-resources/02-learning.mdx b/docs/06-resources/02-learning.mdx similarity index 100% rename from docs/05-resources/02-learning.mdx rename to docs/06-resources/02-learning.mdx diff --git a/docs/05-resources/_category_.json b/docs/06-resources/_category_.json similarity index 100% rename from docs/05-resources/_category_.json rename to docs/06-resources/_category_.json diff --git a/docusaurus.config.ts b/docusaurus.config.ts index f6995cc2..d5633845 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -97,6 +97,11 @@ const config: Config = { position: "left", label: "Resources", }, + { + to: "/getting-started/setup", + position: "right", + label: "Getting started", + }, { type: "search", position: "right",