Skip to main content

Publishing

The docs site is configured for Vercel by default. GitHub Pages remains available as a manual fallback after Pages is enabled in the repository settings.

Vercel Deployment​

Vercel should use these project settings:

Framework Preset: Other
Install Command: npm ci
Build Command: npm run build
Output Directory: build

The same settings are committed in:

vercel.json

Default Docusaurus settings for Vercel:

baseUrl: /
url: derived from DOCUSAURUS_URL, VERCEL_PROJECT_PRODUCTION_URL, VERCEL_URL, or https://lumenbazaar-docs.vercel.app

Set DOCUSAURUS_URL in Vercel only when the production docs domain is known.

GitHub Pages Fallback​

The GitHub Pages workflow is manual only:

.github/workflows/deploy.yml

Before running it, enable Pages in GitHub:

Settings -> Pages -> Source -> GitHub Actions

If Pages is not enabled, actions/deploy-pages returns a 404 when it tries to create the deployment.

The workflow builds with GitHub Pages path settings:

DOCUSAURUS_URL=https://lumenroute.github.io
BASE_URL=/lumenbazaar-docs/

Expected GitHub Pages URL:

https://lumenroute.github.io/lumenbazaar-docs/

Custom Domain​

When a production domain is ready, configure:

DOCUSAURUS_URL=https://docs.example.com
BASE_URL=/

If GitHub Pages is still used with a custom domain, add the required CNAME configuration only after the domain is owned and DNS is ready.

Deployment Workflow​

Publishing is handled by:

.github/workflows/deploy.yml

The workflow runs:

npm ci
npm run lint
npm run links
npm run check:generated
npm run check:content
npm run build

Then it uploads the Docusaurus build folder to GitHub Pages.

Versioning​

The current docs version is labeled Next.

Use versioned docs when:

  • Backend APIs are live and stable.
  • Contract interfaces are deployed.
  • SDK packages are published.
  • Mainnet behavior is launched.
  • External integrations depend on a stable doc snapshot.

Do not publish versioned docs for behavior that is still only planned.

The docs should link to:

Public Feedback​

Use GitHub issues for public docs feedback:

https://github.com/LumenRoute/lumenbazaar-docs/issues

Security-sensitive reports should follow Disclosure Policy instead of public issues.

Publication Checklist​

Before publishing:

  • Lint passes.
  • Local link check passes.
  • Generated-reference check passes.
  • Content quality check passes.
  • Production build passes.
  • External source links are reviewed.
  • No page implies official Stellar, SDF, or SCF endorsement.
  • Testnet and mainnet evidence are clearly separated.
  • Generated references are marked current or stale.