Skip to content

How to build and preview Coral documentation ​

Preview contributor pages locally, build the documentation site, and verify the combined static product from the repository root.

  1. Start the documentation development server.

    sh
    npm run docs:dev

    VitePress prints a local URL when it is ready.

  2. Open the reported URL and navigate to /contribute/.

    The Contribute to Coral index appears with working local navigation.

  3. Stop the development server with Ctrl+C.

    The shell prompt returns and no preview process remains running.

  4. Build the documentation site.

    sh
    npm run docs:build

    VitePress exits successfully and writes docs/.vitepress/dist/contribute/index.html.

  5. From a clean checkout with no existing build/ directory, assemble the application and documentation as one release-shaped product.

    The release branch uses the exact registry-backed @graph-ir/core@0.2.1 dependency. A local path, sibling checkout, archive, or no-save substitution is not release evidence.

    sh
    npm run build:static

    The command creates the application at /coral/, documentation at /coral/docs/, a deterministic ZIP, and its checksum under build/.

  6. Verify the frozen output.

    sh
    npm run verify:static

    The integrity manifest, static tree, ZIP payload, release identity, and checksum all verify without rebuilding the product.

Result ​

The contributor route works in interactive preview and a documentation build. The registry-backed GraphIR adoption is complete. The same procedure proves the combined static shape used by release delivery; Slice 80 repeats the identity-sensitive checks before publication and deployment.