diff --git a/website/docs/faq.md b/website/docs/faq.md index d476bf5..a7ef3a8 100644 --- a/website/docs/faq.md +++ b/website/docs/faq.md @@ -110,7 +110,7 @@ Yes, there are several avenues: How do I set up my development environment? - **New Developers**: Check our **[Beginner Guides](./how-to-guide/beginner/)**. -- **Specific Tools**: See the **[Tools section](./resources/tools.md)**. +- **Specific Tools**: See the **[Tools section](./resources/repositories.md)**. diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index dd32548..591d303 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -49,7 +49,7 @@ Built by the community, for the community. Join our working groups and help shap ### How-To Guides - **[Beginner](./how-to-guide/beginner/)** - Getting started guides for newcomers -- **[Intermediate](./how-to-guide/intermediate/)** - Next-level guides for developers with basic knowledge +- **[Intermediate](./how-to-guide/beginner/)** - Next-level guides for developers with basic knowledge - **Advanced** - Deep-dive technical guides for experienced developers (see [Cardano API](./how-to-guide/advanced/cardano-api.md) and [cardano-db-sync](./how-to-guide/advanced/cardano-db-sync.md)) ### Tutorials @@ -57,7 +57,7 @@ Built by the community, for the community. Join our working groups and help shap ### Resources - **[Repositories](./resources/repositories)** - Essential GitHub repositories and their purposes -- **[Tools](./resources/tools)** - Development tools, APIs, and utilities +- **[Tools](./resources/repositories)** - Development tools, APIs, and utilities - **[Community](./resources/community)** - Community channels, forums, and support resources ### [Working Group](./working-group/) diff --git a/website/docs/how-to-guide/beginner/README.md b/website/docs/how-to-guide/beginner/README.md index c8fc60c..e5a1b94 100644 --- a/website/docs/how-to-guide/beginner/README.md +++ b/website/docs/how-to-guide/beginner/README.md @@ -8,7 +8,7 @@ Welcome to the Beginner Guides section! This area contains step-by-step guides d ### Getting Started with Cardano - **[Address Management](./address.md)** - Understanding Cardano addresses ([Official docs](https://docs.cardano.org/about-cardano/learn/cardano-addresses) | [Developer fundamentals](https://developers.cardano.org/docs/get-started/technical-concepts/core-blockchain-fundamentals/#addresses)) -- **[How to Create Address](./howtocreateaddress.md)** - Step-by-step address creation (Based on [PPBL 102.1](https://plutuspbl.io/)) +- **[How to Create Address](./address.md)** - Step-by-step address creation (Based on [PPBL 102.1](https://plutuspbl.io/)) - **[Inputs and Outputs](./inputsandoutputs.md)** - Understanding transaction structure (See [Module 102 in Plutus PBL](https://plutuspbl.io/) for deeper understanding. For advanced understanding, consider learning basic [Category Theory](https://arxiv.org/abs/1302.6946) - types correspond to objects, functions to morphisms) ## Coming Soon @@ -49,4 +49,4 @@ Found an issue or want to improve a guide? See our [Contributing Guidelines](htt --- -*Ready to dive deeper? Check out our [Intermediate Guides](../intermediate/README.md) when you're comfortable with the basics.* +*Ready to dive deeper? Check out our [Intermediate Guides](../beginner/README.md) when you're comfortable with the basics.* diff --git a/website/docs/how-to-guide/beginner/howtocreateaddress.md b/website/docs/how-to-guide/beginner/howtocreateaddress.md deleted file mode 100644 index 277e014..0000000 --- a/website/docs/how-to-guide/beginner/howtocreateaddress.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -sidebar_label: "How to create a address using Cardano-Cli" -sidebar_position: 3 ---- - -# Create an Address - -## Cardano-Cli diff --git a/website/docs/how-to-guide/intermediate/README.md b/website/docs/how-to-guide/intermediate/README.md deleted file mode 100644 index 01532af..0000000 --- a/website/docs/how-to-guide/intermediate/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# Intermediate Guides - -Welcome to the Intermediate Guides section! These guides are designed for developers who have mastered the basics and are ready to build more complex applications on Cardano. - -## Coming Soon - -### Smart Contract Development -- **Introduction to Plutus** - See [Plutus Pioneer Program](https://plutuspbl.io/) for comprehensive coverage -- **Getting started with Helios** - [TypeScript-based smart contract development](https://helios-lang.io/) (Recommended: 80% of developers globally use TypeScript; Midnight also uses TypeScript) -- **Getting started with Aiken** - Modern Rust-based smart contract language -- **Building your first smart contract** -- **Testing smart contracts** - Including QuickCheck methodology for property-based testing - -### Native Token Development -- Advanced token minting strategies -- Multi-asset transactions -- Token policies and governance - -### dApp Development -- Frontend integration with Cardano -- Wallet connectivity -- Transaction building in applications -- State management for blockchain apps - -### Developer Tools -- **Setting up advanced development environments** - Recommended learning ladder by time-to-productive: Helios → Aiken → Haskell/Plutus -- Using Cardano APIs effectively -- Debugging Cardano applications -- Performance optimization - -## Prerequisites - -Before starting these guides, you should be comfortable with: -- Basic Cardano concepts (addresses, transactions, UTXOs) -- Command-line tools (cardano-cli) -- Programming fundamentals -- Familiarity with [docs.cardano.org](https://docs.cardano.org) and [developers.cardano.org](https://developers.cardano.org) -- Completed at least 2-3 [Beginner Guides](../beginner/README.md) - -## Learning Path - -1. Start with [Beginner Guides](../beginner/README.md) if you haven't already -2. Join the [Developer Experience Working Group](../../working-group/readme.md) for hands-on sessions -3. Practice with testnet before moving to mainnet -4. Progress to Advanced Guides when ready - -## Getting Help - -- **Discord**: First become a member at [Intersect](https://www.intersectmbo.org/) and register at [members.intersectmbo.org](https://members.intersectmbo.org/registration). After joining, you'll get access to our Discord community's #developer-experience channel -- **Working Group**: Attend intermediate workshops and open clinic sessions -- **Community**: [Cardano Stack Exchange](https://cardano.stackexchange.com) - ---- - -*These guides are being developed as part of the Q1 2025 Developer Experience Working Group initiative.* \ No newline at end of file diff --git a/website/docs/resources/repositories.md b/website/docs/resources/repositories.md index ce970cc..8f3b9ef 100644 --- a/website/docs/resources/repositories.md +++ b/website/docs/resources/repositories.md @@ -104,7 +104,7 @@ Data access tools, indexers, and Rust protocol implementations. | [cardano-foundation/CIPs](https://github.com/cardano-foundation/CIPs) | Cardano Improvement Proposals: the formal process for protocol changes and standards | | [Liqwid-Labs/agora](https://github.com/Liqwid-Labs/agora) | On-chain governance framework for DAOs built on Cardano | -> For the CIP contribution process: stages, editors, what qualifies: see the [Core Protocol Contributor Guide](../how-to-guide/advanced/core-protocol-contributor.md#how-to-contribute-a-cip). +> For the CIP contribution process: stages, editors, what qualifies: see the [Core Protocol Contributor Guide](../how-to-guide/advanced/core-protocol-contributor.md). ## Developer Tools & Testing diff --git a/website/docs/resources/tools.md b/website/docs/resources/tools.md deleted file mode 100644 index 06962c0..0000000 --- a/website/docs/resources/tools.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Development Tools & APIs - -## Coming Soon - -This page will catalog essential development tools, APIs, and utilities for Cardano development. - -### What You'll Find -- Development environment tools -- Smart contract development tools -- Wallet integration libraries -- Block explorers and APIs -- Testing and debugging tools - -**Status**: Content in development - ---- - -*This resource guide is part of the Cardano Developer Experience Working Group initiative.* \ No newline at end of file diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 4adc620..a24efe7 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -77,6 +77,29 @@ const config: Config = { }, plugins: [ + [ + "@docusaurus/plugin-client-redirects", + { + redirects: [ + { + from: "/docs/how-to-guide/beginner/howtocreateaddress", + to: "/docs/how-to-guide/beginner/address", + }, + { + from: "/docs/resources/tools", + to: "/docs/resources/repositories", + }, + { + from: "/docs/how-to-guide/intermediate", + to: "/docs/how-to-guide/beginner", + }, + { + from: "/docs/tutorials/readme", + to: "/docs/tutorials/local-cardano-payment-detector", + }, + ], + }, + ], function suppressVscodeLspWarning() { return { name: "suppress-vscode-lsp-warning", @@ -221,7 +244,7 @@ const config: Config = { }, { label: "Tools & APIs", - to: "/docs/resources/tools", + to: "/docs/resources/repositories", }, { label: "FAQs", diff --git a/website/package-lock.json b/website/package-lock.json index 3a499c5..a2d4345 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -10,6 +10,7 @@ "hasInstallScript": true, "dependencies": { "@docusaurus/core": "^3.10.1", + "@docusaurus/plugin-client-redirects": "^3.10.1", "@docusaurus/preset-classic": "^3.10.1", "@docusaurus/theme-mermaid": "^3.10.1", "@easyops-cn/docusaurus-search-local": "^0.55.1", @@ -3695,6 +3696,30 @@ "react-dom": "*" } }, + "node_modules/@docusaurus/plugin-client-redirects": { + "version": "3.10.1", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.10.1.tgz", + "integrity": "sha512-LHgd+YDvkhfOHMAE6XtUng3DQNzVM765RqVRrMJgHtzAvfopQhY6ieprqjxDVBdv21cLma6I0jHr+YCZH8fL9A==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.10.1", + "@docusaurus/logger": "3.10.1", + "@docusaurus/utils": "3.10.1", + "@docusaurus/utils-common": "3.10.1", + "@docusaurus/utils-validation": "3.10.1", + "eta": "^2.2.0", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=20.0" + }, + "peerDependencies": { + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + } + }, "node_modules/@docusaurus/plugin-content-blog": { "version": "3.10.1", "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.10.1.tgz", diff --git a/website/package.json b/website/package.json index b10e72b..12216c3 100644 --- a/website/package.json +++ b/website/package.json @@ -22,6 +22,7 @@ }, "dependencies": { "@docusaurus/core": "^3.10.1", + "@docusaurus/plugin-client-redirects": "^3.10.1", "@docusaurus/preset-classic": "^3.10.1", "@docusaurus/theme-mermaid": "^3.10.1", "@easyops-cn/docusaurus-search-local": "^0.55.1", diff --git a/website/yarn.lock b/website/yarn.lock index 4fcd388..47ebbff 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -1683,6 +1683,21 @@ react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" +"@docusaurus/plugin-client-redirects@^3.10.1": + version "3.10.1" + resolved "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.10.1.tgz" + integrity sha512-LHgd+YDvkhfOHMAE6XtUng3DQNzVM765RqVRrMJgHtzAvfopQhY6ieprqjxDVBdv21cLma6I0jHr+YCZH8fL9A== + dependencies: + "@docusaurus/core" "3.10.1" + "@docusaurus/logger" "3.10.1" + "@docusaurus/utils" "3.10.1" + "@docusaurus/utils-common" "3.10.1" + "@docusaurus/utils-validation" "3.10.1" + eta "^2.2.0" + fs-extra "^11.1.1" + lodash "^4.17.21" + tslib "^2.6.0" + "@docusaurus/plugin-content-blog@3.10.1": version "3.10.1" resolved "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.10.1.tgz" @@ -2382,10 +2397,10 @@ resolved "https://registry.npmjs.org/@noble/hashes/-/hashes-1.4.0.tgz" integrity sha512-V1JJ1WTRUqHHrOSh597hURcMqVKVGL/ea3kv0gSnEdsEZ0/+VyPghM1lMNGc00z7CIQorSvbKpuJkxvuHbvdbg== -"@node-rs/jieba-darwin-arm64@1.10.4": +"@node-rs/jieba-win32-x64-msvc@1.10.4": version "1.10.4" - resolved "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-1.10.4.tgz" - integrity sha512-G++RYEJ2jo0rxF9626KUy90wp06TRUjAsvY/BrIzEOX/ingQYV/HjwQzNPRR1P1o32a6/U8RGo7zEBhfdybL6w== + resolved "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-1.10.4.tgz" + integrity sha512-+sqemSfS1jjb+Tt7InNbNzrRh1Ua3vProVvC4BZRPg010/leCbGFFiQHpzcPRfpxAXZrzG5Y0YBTsPzN/I4yHQ== "@node-rs/jieba@^1.6.0": version "1.10.4" @@ -5511,11 +5526,6 @@ fs-extra@^11.1.1, fs-extra@^11.2.0: jsonfile "^6.0.1" universalify "^2.0.0" -fsevents@~2.3.2: - version "2.3.3" - resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz" - integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== - function-bind@^1.1.2: version "1.1.2" resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz"