feat: Improve docs, readme, banners

Author: wottpal

.changeset/tasty-crabs-study.md

@@ -0,0 +1,5 @@
+---
+'create-inkathon-app': patch
+---
+
+Add link to new documentation

README.md

@@ -1,43 +1,24 @@
-# inkathon v6 Boilerplate (Alpha)
+![inkathon Banner](frontend/public/inkathon-readme-banner.png)
+
+# inkathon v6
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://use.ink)
 ![Rust](https://img.shields.io/badge/Rust-000000?logo=rust&logoColor=white)
 ![TypeScript](https://img.shields.io/badge/TypeScript-000000?logo=typescript&logoColor=white)
 ![Next.js](https://img.shields.io/badge/Next.js-000000?logo=next.js&logoColor=white)
 
-> Next generation full-stack boilerplate for ink! smart contracts running on PolkaVM. Powered by Papi, ReactiveDOT, Pop CLI, and more. – Perfect for kickstarting building hackathon projects.
-
-**Join the discussion in our [Telegram Group](https://t.me/inkathon)** 💬
-
-## About 📖
-
-The inkathon boilerplate offers a complete setup for developing full-stack dApps on Polkadot with ink! smart contracts and Next.js. It now shines in new glory with full ink! v6 support powered by Papi, ReactiveDOT, Pop CLI, and more.
-
-The boilerplate rebuild features:
-
-- Full ink! v6 support & type-safety
-- Revamped build, deployment, and address management scripts
-- Updated stack with Bun, Next.js v15, Tailwind CSS v4 & shadcn/ui
-- New `create-inkathon-app` CLI for setting up the boilerplate in seconds
-
-The inkathon boilerplate is almost as old as ink! itself. With accumulated over 200 stars, more than 250 public projects depending on it and the most active [ink! Telegram group](https://t.me/inkathon).
+> Next generation full-stack boilerplate for ink! smart contracts running on PolkaVM. Powered by Papi, ReactiveDOT, Pop CLI, and more.
 
-> [!NOTE]  
-> The old ink! v5 compatible boilerplate is available on the [`v1` branch](https://github.com/scio-labs/inkathon/tree/v1).
-
-## Getting Started 🚀
-
-- [1. Run the frontend](#1-run-the-frontend)
-- [2. Build & deploy contracts on a local node](#2-build--deploy-contracts-on-a-local-node)
-- [3. Connect the frontend to the local node](#3-connect-the-frontend-to-the-local-node)
-- [4. Adding a new network](#4-adding-a-new-network)
+- 🤖 **Check out the [live demo](https://inkathon.xyz)**
+- 📖 **Explore our new [documentation](https://docs.inkathon.xyz)**
+- 💬 **Join the discussion on [Telegram](https://t.me/inkathon)**
 
-### 1. Run the frontend
+## Quickstart ⚡
 
 > [!IMPORTANT]
 >
-> - Setup Node.js v22 (recommended via [nvm](https://github.com/nvm-sh/nvm))
+> - Setup Node.js v20 or v22 (recommended via [nvm](https://github.com/nvm-sh/nvm))
 > - Install [Bun](https://bun.sh/)
 
 Use the new `create-inkathon-app` CLI to set up the boilerplate:
@@ -47,120 +28,32 @@ bunx create-inkathon-app@latest
 
 cd <project-name>
 
-# Executed from the root or /frontend directory
 bun run dev
 ```
 
----
-
-### 2. Build & deploy contracts on a local node
-
-> [!IMPORTANT]
->
-> - Setup your environment with Pop CLI: [Guide](https://learn.onpop.io/welcome/install-pop-cli)
-> - Install `cargo-contract` with `cargo install cargo-contract@6.0.0-alpha --locked`
-> - Install `ink-node` by [downloading it's binary](https://github.com/use-ink/ink-node/releases)
-> - Make `ink-node` available globally by moving it to `/usr/local/bin` with `sudo mv ink-node /usr/local/bin/`
-
-1. Add your contract (or just continue with the provided `flipper` example)
-2. Build your contract
-
-```bash
-# Executed from the /contracts directory
-bun run build
-```
-
-3. Run the local `ink-node` in the background
-
-```bash
-# Executed from the /contracts directory
-bun run node
-```
-
-4. (Re-)generate PAPI types
-
-```bash
-# Executed from the /contracts directory
-bun run codegen
-```
-
-5. Deploy your contract
+Learn more in our new [documentation](https://docs.inkathon.xyz).
 
-Put your signers `ACCOUNT_URI` in `.env.<chain>` (e.g. `.env.pop`). By default, the `//Alice` account is used.
+## About the project
 
-```bash
-# Executed from the /contracts directory
-# If `CHAIN` is not set, it will default to `dev`
-CHAIN=dev bun run deploy
-```
-
-> [!NOTE]
->
-> The `deploy.sh` script triggered by `bun run deploy` will automatically export the deployed contract addresses under `/contracts/deployments/<contract>/<chain>.ts`. These files are used to be cross-imported in the frontend in `frontend/src/lib/inkathon/deployments.ts`.
-
----
-
-### 3. Connect the frontend to the local node
-
-> [!NOTE]
->
-> Tip: You can also run Next.js and `ink-node` in parallel via `bun run dev-and-node` (executed from the project root).
-
-1. Go to `frontend/src/lib/reactive-dot/config.ts` and uncomment the `dev` chain
-2. Go to `frontend/src/lib/inkathon/deployments.ts` and uncomment the `dev` address imports & exports
-3. That's it! 🎉
-
----
-
-### 4. Adding a new network
-
-1. (Re-)generate PAPI types
-
-```bash
-# Executed from the /contracts directory
-bunx papi add -w <websocket-url> <chain-name>
-```
-
-2. (Re-)deploy your contract
-
-```bash
-# Executed from the /contracts directory
-CHAIN=<chain-name> bun run deploy
-```
-
-3. Add the new network to the frontend under `frontend/src/lib/reactive-dot/config.ts`
-
-## Hosting 📡
+The inkathon boilerplate is almost as old as ink! itself. With over 200 stars, more than 250 public projects depending on it, and the most active [ink! Telegram group](https://t.me/inkathon).
 
-### Self-hosting
+It offers a complete setup for developing full-stack dApps on Polkadot with ink! smart contracts and Next.js and now shines in new glory with full ink! v6 support. Powered by Papi, ReactiveDOT, Pop CLI, and more.
 
-This new version of the boilerplates treats self-hosting as a first-class citizen. The boilerplate comes with a state-of-the-art Dockerfile configuration for Next.js self-hosting. We even have a self-hosted version of inkathon.xyz running under `https://inkathon.scio.xyz`.
+## New Features in v6
 
-Try to build & run the Docker image locally:
+The boilerplate has been completely rebuilt with:
 
-```bash
-# Executed from the root directory
-docker build -t inkathon .
-docker run -p 3000:3000 inkathon
-```
+- **Full ink! v6 support** with PolkaVM compatibility
+- **Type-safe contract interactions** via PAPI
+- **Modern stack**: Bun, Next.js 15, React 19, Tailwind CSS v4
+- **Improved DX**: Better build scripts & deployment automation
+- **Production-ready**: Docker support, self-hosting optimized
+- **New `create-inkathon-app` CLI** for setting up the boilerplate in seconds
+- **New [documentation](https://docs.inkathon.xyz)** with educational resources & guides
 
-### Vercel
+## Changelog
 
-The boilerplate is also ready to be deployed to Vercel using the `vercel.json` configuration file at the root of the project.
-
-## To-Dos
+> [!NOTE]  
+> The old ink! v5 compatible boilerplate is available on the [`v1` branch](https://github.com/scio-labs/inkathon/tree/v1).
 
-> [!IMPORTANT]
->
-> This is an alpha release. Use it at your own risk.
-
-- [x] Network Selector
-- [x] Show Balance in UI
-- [x] Account/Address Switcher
-- [x] Indicator & Action to map accounts
-- [x] Faucet Direct Links
-- [x] Dockerfile for self-hosting
-- [x] Rust VSCode setup
-- [x] Claude & Cursor Rules
-- [x] New `create-inkathon-app` CLI for setting up the boilerplate
-- [ ] Chain configuration via environment
+The v6 changelog is available on the [GitHub releases page](https://github.com/scio-labs/inkathon/releases).

bun.lock

@@ -1,7 +1,8 @@
 import { readdir, rm } from "node:fs/promises"
 import { join } from "node:path"
 
-const DIRECTORIES_TO_REMOVE = [".changeset", ".github", "create-inkathon-app", "docs"]
+const DIRECTORIES_TO_REMOVE: string[] = [".changeset", ".github", "create-inkathon-app", "docs"]
+const FILES_TO_REMOVE: string[] = []
 
 async function cleanupDirectories(projectPath: string): Promise<void> {
   for (const dir of DIRECTORIES_TO_REMOVE) {
@@ -13,6 +14,16 @@ async function cleanupDirectories(projectPath: string): Promise<void> {
   }
 }
 
+async function cleanupFiles(projectPath: string): Promise<void> {
+  for (const file of FILES_TO_REMOVE) {
+    try {
+      await rm(join(projectPath, file), { force: true })
+    } catch (error) {
+      // Silently continue if file doesn't exist
+    }
+  }
+}
+
 async function cleanupChangelogFiles(projectPath: string): Promise<void> {
   async function removeChangelogsRecursively(dir: string): Promise<void> {
     const entries = await readdir(dir, { withFileTypes: true })
@@ -41,5 +52,6 @@ async function cleanupChangelogFiles(projectPath: string): Promise<void> {
 
 export async function cleanupRepository(projectPath: string): Promise<void> {
   await cleanupDirectories(projectPath)
+  await cleanupFiles(projectPath)
   await cleanupChangelogFiles(projectPath)
 }

create-inkathon-app/src/cleanup.ts

@@ -15,7 +15,8 @@ export function displayIntro(): void {
   console.log("Next generation full-stack boilerplate for ink! smart contracts")
   console.log("running on PolkaVM. Powered by Papi, ReactiveDOT, Pop CLI, and more.")
   console.log()
-  console.log(`• Demo: ${pc.cyan("https://inkathon.xyz")}`)
+  console.log(`• Live Demo: ${pc.cyan("https://inkathon.xyz")}`)
+  console.log(`• Docs: ${pc.cyan("https://docs.inkathon.xyz")}`)
   console.log(`• Repository: ${pc.cyan("https://github.com/scio-labs/inkathon")}`)
 
   console.log()

create-inkathon-app/src/utils/messages.ts

@@ -0,0 +1,30 @@
+---
+title: About
+description: Kickstart your ink! hackathon projects and production dApps.
+---
+
+## The Project
+
+The inkathon boilerplate is almost as old as ink! itself. With over 200 stars, more than 250 public projects depending on it, and the most active [ink! Telegram group](https://t.me/inkathon).
+
+It offers a complete setup for developing full-stack dApps on Polkadot with ink! smart contracts and Next.js and now shines in new glory with full ink! v6 support. Powered by Papi, ReactiveDOT, Pop CLI, and more.
+
+## New Features in v6
+
+The boilerplate has been completely rebuilt with:
+
+- **Full ink! v6 support** with PolkaVM compatibility
+- **Type-safe contract interactions** via PAPI
+- **Modern stack**: Bun, Next.js 15, React 19, Tailwind CSS v4
+- **Improved DX**: Better build scripts & deployment automation
+- **Production-ready**: Docker support, self-hosting optimized
+- **New `create-inkathon-app` CLI** for setting up the boilerplate in seconds
+
+## Changelog
+
+<Callout title="ink! v5 Support">
+  The old ink! v5 compatible boilerplate and documentation is available on the
+  [`v1`](https://github.com/scio-labs/inkathon/tree/v1) branch.
+</Callout>
+
+The v6 changelog is available on the [GitHub releases page](https://github.com/scio-labs/inkathon/releases).