The inkonchain/docs repository is a documentation platform for InkChain built with Next.js and Nextra, serving as the central reference for the InkChain blockchain ecosystem. The repository is written primarily in MDX and is hosted at docs.inkonchain.com. It functions as a comprehensive developer guide covering blockchain concepts, smart contracts, decentralized applications, cryptocurrency, tokens, protocol specifications, ecosystem information, and roadmap details.
The documentation application is constructed on Nextra, a framework that simplifies documentation site creation, with Next.js providing the underlying web framework. The project currently uses the Pages Router for navigation and routing due to compatibility limitations that have prevented migration to the App Router. The development environment requires Node.js version 20.11.0 or higher. The repository includes Docker support for containerized builds and deployment, allowing developers to build and run the documentation platform in isolated environments.
The project maintains code and documentation quality through a comprehensive tooling stack. CSpell provides real-time spell checking to catch errors in documentation content. Remark processes and renders Markdown content with additional plugins to enhance functionality. ESLint catches potential code quality issues, while Prettier enforces consistent code formatting across the codebase. Tailwind CSS serves as the utility-first CSS framework enabling responsive UI development. For domain-specific terms like InkChain, the project maintains a whitelist in the cspell/project-words.txt file to prevent false positives during spell checking.
The repository implements an automated CI/CD pipeline using GitHub Actions that runs on every pull request. The pipeline includes four primary checks: js-lint for JavaScript formatting validation, md-lint for Markdown formatting verification, format for consistent code style enforcement, and spell-check for documentation accuracy. Feature branch deployments are handled through AWS Amplify, which automatically creates temporary environments for each pull request. This enables live testing and review of changes before merging, with deployment URLs automatically provided in PR checks for team member review.
Production deployments are configured for continuous deployment from the main branch via AWS Amplify. Every merge to main triggers an automatic build and deployment cycle, ensuring the latest documentation version is always available to users without requiring manual intervention. GitGenius activity tracking shows a median issue and PR response latency of 15 hours across 19 tracked items, with mean response time of 256.4 hours. The most active contributors tracked include MdNoor55669 with 4 events, bherderlex with 3 events, and dian020 with 2 events. The repository shares contributors with pytorch/pytorch, responsively-org/responsively-app, and scikit-learn/scikit-learn, indicating cross-project collaboration within the development community.
