docs README

The project's README from github.com/inkonchain/docs. As one markdown file: README.md.

Twitter

InkChain Documentation App

An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain.

🚀 Build & Run

  1. Build Docker image:

    docker build -t docs .
    
  2. Run Docker container:

    docker run -p 3000:3000 docs
    

📋 Requirements

📖 Overview

This is a documentation application powered by Nextra and built on Next.js. 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:
    pnpm install
    
  3. Start development server:
    pnpm run dev
    

🛠 Tooling

Our development setup includes multiple tools to maintain high-quality code and documentation:

🚦 CI/CD Pipeline

Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR):

🌐 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.

docs (inkonchain/docs)

Searching Database…

36.5K ·GitHub
Что это такое?Это сайт документации для InkChain (Ink), платформы документации, построенной на Next.js и Nextra, на которой размещены документы InkChain.
Это самостоятельное приложение или просто файлы markdown?Это полноценное веб-приложение на Next.js, работающее на базе Nextra (с использованием Pages Router), а не просто папка с файлами markdown.
Как запустить это локально?Склонируйте репозиторий, установите зависимости, затем запустите сервер разработки (next dev). Его также можно собрать и запустить как образ Docker.
Что нужно установить в первую очередь?Нужен Node.js версии v20.11.0 или выше. Зависимости управляются через package.json (Next.js, Nextra, React).
Используется ли последний App Router в Next.js?Нет, проект всё ещё использует Pages Router из-за ограничений совместимости с Nextra и не переведён на App Router.
Где это работает?Это веб-приложение, которое развёртывается в продакшене через AWS Amplify из ветки main. Для каждого PR создаётся временная версия для предпросмотра.
Какие инструменты проверяют качество документации?В репозитории используются CSpell для проверки орфографии, Remark для обработки markdown, ESLint для качества кода, Prettier для форматирования и Tailwind CSS для стилей.
Что происходит, когда я открываю PR?GitHub Actions запускает задачи lint, markdown-lint, format и spell-check, а AWS Amplify развёртывает временное окружение для предпросмотра, ссылка на которое публикуется в проверках PR.
Как добавить свой термин, чтобы проверка орфографии его не отмечала?Добавьте уникальные термины, например 'InkChain', в файл ./cspell/project-words.txt, чтобы занести их в белый список.
Creator
inkonchain
Size
25.3 MB
Stars
36.5K
Updated
CommitOct 14
Age
2y
Commits · 90 Days