CI/CD

Mon, 01 Jan 0001 00:00:00 +0000

Agent-support checks

The site has an AFDocs configuration and npm script to generate a scorecard locally:

Config: docsy.dev/agent-docs.config.yml
Script: _check:afdocs in docsy.dev/package.json

To generate a fresh scorecard, run each of these commands in separate terminals:

npm run serve # From one terminal
npm run check:afdocs:dev # From another terminal

The latter command saves the generated scorecard to docs/content/agent-support/afdocs-scorecard.txt under docsy.dev/content/en, which will be included in Scorecard examples on the next build.

Note that the scorecard generation is not run as a part of the full CI/CD pipeline. It needs to be run manually.

Git repo info and branch model

Mon, 01 Jan 0001 00:00:00 +0000

Monorepo

The main Docsy repository is effectively a monorepo containing the Docsy:

Theme at the repo root
Website in the docsy.dev directory. The website uses the Docsy theme, of course, with extra styling.

These two projects are kept in sync at release points, but they may diverge between releases, usually to allow the website to ship doc content and UX improvements without forcing a theme release.

The main Docsy example site is Goldydocs, located in the Docsy example site repository.

Build on Docsy

CI/CD

Agent-support checks

Git repo info and branch model

Monorepo