Skip to main content

Documentation & Blog

Introduction​

This repository hosts the source code for the Inky Documentation Site. The site serves two main purposes:

  • General Documentation: Guides and resources for the project.
  • Blog: Updates and notes from our meetings.

Source Code​

All content is managed within the Crab-Ink-Gaming organization repository: https://github.com/Crab-Ink-gaming/docs/

Technical Stack​

This site is built using Docusaurus, an open-source static site generator by Meta powered by React.

Local Development​

The project uses yarn for package management. To set up the environment locally:

  1. Install dependencies:

    yarn

  2. Start the development server:

    yarn start

Deployment Workflow​

We use an automated CI/CD pipeline via GitHub Actions.

  1. Trigger: When code is pushed to the organization repository, a GitHub Action is triggered.
  2. Build: The action builds the static website.
  3. Deploy: The built files are pushed to a private repository (victorboudet) which serves the content via GitHub Pages.

Important: The deployment pipeline includes build verification. If your code contains errors, the build will fail, and the site will not deploy. Always test your changes locally using yarn start before pushing.

Reference: This workflow follows the Docusaurus GitHub Pages deployment guide.