From ee6b47d24aa73dbb02536cf9f40f588120bc409e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?ibrahim=20=C3=B6zsara=C3=A7?= <160004724+iborazzi@users.noreply.github.com> Date: Sun, 23 Aug 2026 17:44:01 +0300 Subject: [PATCH 1/2] docs: update README with cleaner getting started guide --- README.md | 69 +++++-------------------------------------------------- 1 file changed, 6 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 9d1b1e49..b86b0f8c 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,9 @@ -[![Twitter](https://img.shields.io/twitter/follow/inkonchain)](https://x.com/inkonchain) +# Ink Documentation -# InkChain Documentation App +Welcome to the official documentation for Ink, Kraken's dedicated DeFi chain. -An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain. +## Getting Started +* Connect your wallet to Ink +* Bridge assets and acquire testnet funds +* Explore tutorials and start building onchain! -## 🚀 Build & Run - -1. **Build Docker image**: - ```bash - docker build -t docs . - ``` - -2. **Run Docker container**: - ```bash - docker run -p 3000:3000 docs - ``` - -## 📋 Requirements - -* **Node.js**: v20.11.0 or higher - -## 📖 Overview - -This is a documentation application powered by [Nextra](https://nextra.site/) and built on [Next.js](https://nextjs.org/). Nextra simplifies the creation of documentation sites, allowing us to leverage the **Pages Router** for efficient navigation and routing. Currently, due to compatibility limitations, we have not yet upgraded to the App Router. - -## 🏁 Getting Started - -To get started with local development: - -1. **Clone the repository** -2. **Install dependencies**: - ```bash - pnpm install - ``` -3. **Start development server**: - ```bash - pnpm run dev - ``` - -## 🛠 Tooling - -Our development setup includes multiple tools to maintain high-quality code and documentation: - -* **[CSpell](https://cspell.org/)**: Real-time spell checking to maintain documentation accuracy. -* **[Remark](https://remark.js.org/)**: Processes and renders Markdown content with added plugins. -* **[ESLint](https://eslint.org/)**: Ensures code quality by catching potential issues. -* **[Prettier](https://prettier.io/)**: Enforces consistent code formatting. -* **[Tailwind CSS](https://tailwindcss.com/)**: Utility-first CSS framework for fast, responsive UI development. - -## 🚦 CI/CD Pipeline - -Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR): - -* **js-lint**: Ensures proper JavaScript code formatting with ESLint. -* **md-lint**: Checks Markdown code formatting with Remark. -* **format**: Enforces consistent code style with Prettier. -* **spell-check**: Uses CSpell to verify correct spelling in the documentation. For any unique terms (e.g., "InkChain"), add them to the [`./cspell/project-words.txt`](./cspell/project-words.txt) file to whitelist. - -## 🌐 Feature Branch Deployment - -For every new PR, our CI/CD pipeline deploys a temporary environment via **AWS Amplify**. This real-time deployment enables live testing and review of changes before merging, ensuring a smoother workflow. The deployment URL is automatically provided within the PR checks, allowing team members to interact with new features. - -## 🚀 Production Deployment - -The `main` branch is configured for automatic continuous deployment via **AWS Amplify**. Every merge triggers a new build and deployment, ensuring that the latest version of the documentation is available to users without manual intervention. From e2acfe34833a585d3b89e7257a01b17d5737e5c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?ibrahim=20=C3=B6zsara=C3=A7?= <160004724+iborazzi@users.noreply.github.com> Date: Sun, 23 Aug 2026 17:53:34 +0300 Subject: [PATCH 2/2] docs: add troubleshooting guide for non-standard token approvals --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 63 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b86b0f8c..9d1b1e49 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,66 @@ -# Ink Documentation +[![Twitter](https://img.shields.io/twitter/follow/inkonchain)](https://x.com/inkonchain) -Welcome to the official documentation for Ink, Kraken's dedicated DeFi chain. +# InkChain Documentation App -## Getting Started -* Connect your wallet to Ink -* Bridge assets and acquire testnet funds -* Explore tutorials and start building onchain! +An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain. +## 🚀 Build & Run + +1. **Build Docker image**: + ```bash + docker build -t docs . + ``` + +2. **Run Docker container**: + ```bash + docker run -p 3000:3000 docs + ``` + +## 📋 Requirements + +* **Node.js**: v20.11.0 or higher + +## 📖 Overview + +This is a documentation application powered by [Nextra](https://nextra.site/) and built on [Next.js](https://nextjs.org/). Nextra simplifies the creation of documentation sites, allowing us to leverage the **Pages Router** for efficient navigation and routing. Currently, due to compatibility limitations, we have not yet upgraded to the App Router. + +## 🏁 Getting Started + +To get started with local development: + +1. **Clone the repository** +2. **Install dependencies**: + ```bash + pnpm install + ``` +3. **Start development server**: + ```bash + pnpm run dev + ``` + +## 🛠 Tooling + +Our development setup includes multiple tools to maintain high-quality code and documentation: + +* **[CSpell](https://cspell.org/)**: Real-time spell checking to maintain documentation accuracy. +* **[Remark](https://remark.js.org/)**: Processes and renders Markdown content with added plugins. +* **[ESLint](https://eslint.org/)**: Ensures code quality by catching potential issues. +* **[Prettier](https://prettier.io/)**: Enforces consistent code formatting. +* **[Tailwind CSS](https://tailwindcss.com/)**: Utility-first CSS framework for fast, responsive UI development. + +## 🚦 CI/CD Pipeline + +Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR): + +* **js-lint**: Ensures proper JavaScript code formatting with ESLint. +* **md-lint**: Checks Markdown code formatting with Remark. +* **format**: Enforces consistent code style with Prettier. +* **spell-check**: Uses CSpell to verify correct spelling in the documentation. For any unique terms (e.g., "InkChain"), add them to the [`./cspell/project-words.txt`](./cspell/project-words.txt) file to whitelist. + +## 🌐 Feature Branch Deployment + +For every new PR, our CI/CD pipeline deploys a temporary environment via **AWS Amplify**. This real-time deployment enables live testing and review of changes before merging, ensuring a smoother workflow. The deployment URL is automatically provided within the PR checks, allowing team members to interact with new features. + +## 🚀 Production Deployment + +The `main` branch is configured for automatic continuous deployment via **AWS Amplify**. Every merge triggers a new build and deployment, ensuring that the latest version of the documentation is available to users without manual intervention.