Blink Labs documentation

Documentation for Blink Labs open-source Cardano infrastructure, APIs, and developer tools. The production site is available at docs.blinklabs.io.

Local development

Requirements:

• Node.js >=22.22.0
• npm

Install dependencies and start the Astro development server:

npm ci
npm run dev

The site is available at http://localhost:4321.

Validate a change

Run the documentation checks and production build before opening a pull request:

npm run check

This packages the downloadable Dingo, gOuroboros, and Adder guide examples, checks the documentation and generated LLM files, and builds the site. The static site, Pagefind search index, sitemap, and LLM-friendly text files are generated in dist/.

To build the site without running the documentation checks, use:

npm run build

The build lifecycle also packages the downloadable guide examples.

Content structure

• src/content/docs/ contains English documentation.
• src/content/docs/ja/ contains Japanese translations.
• src/content/docs/es/ contains Spanish translations.
• public/ contains static assets, including packaged downloadable guide examples.
• astro.config.mjs defines Starlight, locales, and sidebar navigation.

Add product documentation under src/content/docs/guides/<product>/. Keep translated filenames aligned with their English counterparts so Starlight can generate correct language alternatives.

Contributing

Use focused pull requests and include:

• A concise explanation of the user-facing change.
• Updated translations when the same content exists in Japanese or Spanish.
• A successful npm run check.

Report documentation issues or propose improvements in the Blink Labs docs repository.