Skip to content

Build official VitePress documentation with compiler-verified examples and CI - #1

Merged
sanskarIN merged 3 commits into
mainfrom
docs/conformance-and-maintenance
Nov 1, 2026
Merged

sanskarIN merged 3 commits into
mainfrom
docs/conformance-and-maintenance

Conversation

@sanskarIN

Copy link
Copy Markdown
Member

Summary

  • Introduce the official responsive VitePress documentation site with Scarp branding, local search, light/dark themes, TypeScript config and navigation.
  • Document only implemented Scarp v0.0.5-alpha.1 syntax/CLI, with explicit prerelease status, installation, learning guides, source modules, numerical primitives, Rust embedding, and limitations.
  • Add seven exact source/stdout fixtures copied from the published Scarp release, with 16 verified upstream Git blob IDs and pin the compiler SHA.
  • Add documentation link/anchor checks, evidence checks, compiler-backed run/check/tokens CI, and GitHub Pages deployment on main.
  • Add README, contribution process, templates, dependabot, and deployment checklist.

Validation performed locally

  • npm run check:docs — PASS (29 Markdown pages, 200 link references)
  • npm run check:fixtures — PASS (7 cases / 16 Git blob identities)
  • YAML/JavaScript syntax checks — PASS
  • Full VitePress build and compiler conformance must be confirmed by GitHub Actions because npm registry and Rust toolchain were not available in the local environment.

Review / release gate

Do not merge until GitHub Actions Documentation CI passes. Once green, merge to main to trigger the Pages workflow, and select Settings → Pages → GitHub Actions if the repository has not yet done so. The Scarp compiler and language APIs remain prerelease/experimental.

Authored-by: Sanskar <sanskarin@outlook.in>
Authored-by: Sanskar <sanskarin@outlook.in>
Authored-by: Sanskar <sanskarin@outlook.in>
@sanskarIN
sanskarIN marked this pull request as ready for review November 1, 2026 11:00
@sanskarIN
sanskarIN merged commit 4bc7a45 into main Nov 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant