From 394205ede9e8fa58e21eb49cf3f2bce83f00b935 Mon Sep 17 00:00:00 2001 From: danbaruka <46156791+danbaruka@users.noreply.github.com> Date: Mon, 3 Aug 2026 20:28:01 +0400 Subject: [PATCH] docs: remove empty and redundant website pages Remove stub pages called out in #191 (howtocreateaddress, tools Coming Soon, empty Intermediate section, redundant Tutorials index). Point nav and FAQ to filled resources instead, and draft Q2 recording pages that only say TBD. Fixes #191 --- website/docs/faq.md | 2 +- website/docs/getting-started.md | 6 +- website/docs/how-to-guide/beginner/README.md | 5 +- .../beginner/howtocreateaddress.md | 8 --- .../docs/how-to-guide/intermediate/README.md | 55 ------------------- website/docs/resources/tools.md | 22 -------- website/docs/tutorials/readme.md | 6 -- .../recordings/readme.md | 1 + .../recordings/readme.md | 1 + .../recordings/readme.md | 1 + website/docusaurus.config.ts | 4 +- 11 files changed, 10 insertions(+), 101 deletions(-) delete mode 100644 website/docs/how-to-guide/beginner/howtocreateaddress.md delete mode 100644 website/docs/how-to-guide/intermediate/README.md delete mode 100644 website/docs/resources/tools.md delete mode 100644 website/docs/tutorials/readme.md diff --git a/website/docs/faq.md b/website/docs/faq.md index d476bf5..ea6ed38 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)**. +- **Tools and APIs**: See the **[Repositories](./resources/repositories.md)** catalog and [developers.cardano.org](https://developers.cardano.org). diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index dd32548..c019c3a 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -49,15 +49,13 @@ 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 - **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 -- **Hands-On** - Interactive coding tutorials and workshops +- **[Hands-On tutorials](./tutorials/local-cardano-payment-detector.md)** - Interactive coding tutorials and workshops ### Resources -- **[Repositories](./resources/repositories)** - Essential GitHub repositories and their purposes -- **[Tools](./resources/tools)** - Development tools, APIs, and utilities +- **[Repositories](./resources/repositories)** - Essential GitHub repositories, tools, and APIs - **[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..b0433c0 100644 --- a/website/docs/how-to-guide/beginner/README.md +++ b/website/docs/how-to-guide/beginner/README.md @@ -7,8 +7,7 @@ Welcome to the Beginner Guides section! This area contains step-by-step guides d ## Current Guides ### 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/)) +- **[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) | [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 +48,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? Continue with the [Advanced Guides](../advanced/README.md) or join a [Working Group session](../../working-group/readme.md).* 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/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/docs/tutorials/readme.md b/website/docs/tutorials/readme.md deleted file mode 100644 index 6978165..0000000 --- a/website/docs/tutorials/readme.md +++ /dev/null @@ -1,6 +0,0 @@ -# Tutorials - -## Build a Local Cardano Payment Detector using Cardano Node Emulator - -Find the tutorial [here](./local-cardano-payment-detector.md) - diff --git a/website/docs/working-group/sessions/q2-2026/16-ui-smart-contract-interaction/recordings/readme.md b/website/docs/working-group/sessions/q2-2026/16-ui-smart-contract-interaction/recordings/readme.md index b6f9bf1..118989f 100644 --- a/website/docs/working-group/sessions/q2-2026/16-ui-smart-contract-interaction/recordings/readme.md +++ b/website/docs/working-group/sessions/q2-2026/16-ui-smart-contract-interaction/recordings/readme.md @@ -1,4 +1,5 @@ --- +draft: true title: "Session 16: UI ↔ Smart Contracts (Wallets + Tx flow) - Recordings" sidebar_label: Recordings --- diff --git a/website/docs/working-group/sessions/q2-2026/17-default-developer-environment/recordings/readme.md b/website/docs/working-group/sessions/q2-2026/17-default-developer-environment/recordings/readme.md index 1e88662..0cccf1b 100644 --- a/website/docs/working-group/sessions/q2-2026/17-default-developer-environment/recordings/readme.md +++ b/website/docs/working-group/sessions/q2-2026/17-default-developer-environment/recordings/readme.md @@ -1,4 +1,5 @@ --- +draft: true title: "Session 17: Default Developer Environment for Cardano - Recordings" sidebar_label: Recordings --- diff --git a/website/docs/working-group/sessions/q2-2026/19-one-api-call-blockfrost/recordings/readme.md b/website/docs/working-group/sessions/q2-2026/19-one-api-call-blockfrost/recordings/readme.md index 7ebe02d..553801e 100644 --- a/website/docs/working-group/sessions/q2-2026/19-one-api-call-blockfrost/recordings/readme.md +++ b/website/docs/working-group/sessions/q2-2026/19-one-api-call-blockfrost/recordings/readme.md @@ -1,4 +1,5 @@ --- +draft: true title: "Session 19: One API Call to Understand Cardano - Recordings" sidebar_label: Recordings --- diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 4adc620..a81de77 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -220,8 +220,8 @@ const config: Config = { to: "/docs/resources/community", }, { - label: "Tools & APIs", - to: "/docs/resources/tools", + label: "Repositories & Tools", + to: "/docs/resources/repositories", }, { label: "FAQs",