|
1 | | -[](https://x.com/inkonchain) |
| 1 | +# Ink Documentation |
2 | 2 |
|
3 | | -# InkChain Documentation App |
| 3 | +Welcome to the official documentation for Ink, Kraken's dedicated DeFi chain. |
4 | 4 |
|
5 | | -An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain. |
| 5 | +## Getting Started |
| 6 | +* Connect your wallet to Ink |
| 7 | +* Bridge assets and acquire testnet funds |
| 8 | +* Explore tutorials and start building onchain! |
6 | 9 |
|
7 | | -## 🚀 Build & Run |
8 | | - |
9 | | -1. **Build Docker image**: |
10 | | - ```bash |
11 | | - docker build -t docs . |
12 | | - ``` |
13 | | - |
14 | | -2. **Run Docker container**: |
15 | | - ```bash |
16 | | - docker run -p 3000:3000 docs |
17 | | - ``` |
18 | | - |
19 | | -## 📋 Requirements |
20 | | - |
21 | | -* **Node.js**: v20.11.0 or higher |
22 | | - |
23 | | -## 📖 Overview |
24 | | - |
25 | | -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. |
26 | | - |
27 | | -## 🏁 Getting Started |
28 | | - |
29 | | -To get started with local development: |
30 | | - |
31 | | -1. **Clone the repository** |
32 | | -2. **Install dependencies**: |
33 | | - ```bash |
34 | | - pnpm install |
35 | | - ``` |
36 | | -3. **Start development server**: |
37 | | - ```bash |
38 | | - pnpm run dev |
39 | | - ``` |
40 | | - |
41 | | -## 🛠 Tooling |
42 | | - |
43 | | -Our development setup includes multiple tools to maintain high-quality code and documentation: |
44 | | - |
45 | | -* **[CSpell](https://cspell.org/)**: Real-time spell checking to maintain documentation accuracy. |
46 | | -* **[Remark](https://remark.js.org/)**: Processes and renders Markdown content with added plugins. |
47 | | -* **[ESLint](https://eslint.org/)**: Ensures code quality by catching potential issues. |
48 | | -* **[Prettier](https://prettier.io/)**: Enforces consistent code formatting. |
49 | | -* **[Tailwind CSS](https://tailwindcss.com/)**: Utility-first CSS framework for fast, responsive UI development. |
50 | | - |
51 | | -## 🚦 CI/CD Pipeline |
52 | | - |
53 | | -Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR): |
54 | | - |
55 | | -* **js-lint**: Ensures proper JavaScript code formatting with ESLint. |
56 | | -* **md-lint**: Checks Markdown code formatting with Remark. |
57 | | -* **format**: Enforces consistent code style with Prettier. |
58 | | -* **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. |
59 | | - |
60 | | -## 🌐 Feature Branch Deployment |
61 | | - |
62 | | -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. |
63 | | - |
64 | | -## 🚀 Production Deployment |
65 | | - |
66 | | -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. |
0 commit comments