build: add CI workflow for format check and markdown audit

[saif-at-scalekit]

Summary

• Adds .github/workflows/ci.yml to run on every push and PR
• Runs format check (pnpm run format:check) and agent markdown audit (node scripts/agent-markdown-audit.js)
• Uses Node 24 with pnpm caching for fast installs

Summary by CodeRabbit

• Chores
  • Established automated code quality checks via continuous integration, including type checking, format validation, and markdown auditing that run on all pull requests and code pushes to ensure consistent code standards.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 46d6b4dd-5c4c-4562-a7f3-a8886b7e97a8

📥 Commits

Reviewing files that changed from the base of the PR and between 705c2e2 and a9b7632.

📒 Files selected for processing (1)

• .github/workflows/ci.yml

📜 Recent review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Redirect rules - scalekit-starlight
• GitHub Check: Header rules - scalekit-starlight
• GitHub Check: Pages changed - scalekit-starlight

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.

Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: All changes must pass format checking with Prettier, build process without errors, Git hook validations, and content structure validation

Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Documentation must pass format checking with Prettier

📚 Learning: 2026-04-20T11:29:40.242Z

Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: All changes must pass format checking with Prettier, build process without errors, Git hook validations, and content structure validation

Applied to files:

• .github/workflows/ci.yml

🔇 Additional comments (2)

.github/workflows/ci.yml (2)

31-32: Good use of strict markdown audit as a hard CI gate.

Running agent-markdown-audit.js --strict is a solid quality guardrail for docs safety and prevents lossy-risk pages from slipping in.

Based on learnings "All changes must pass format checking with Prettier, build process without errors, Git hook validations, and content structure validation".

---

17-20: Verify the Node.js version requirement before updating.

The workflow currently uses node-version: 20 at line 19. However, the repository does not specify a canonical Node.js version in package.json (no engines field), .nvmrc, .node-version, or other standard configuration files. Before updating this value, confirm the intended target version through the PR description, issue, or maintainer guidance—changing it without verification could introduce unexpected compatibility issues.

			> Likely an incorrect or invalid review comment.

---

Walkthrough

A new GitHub Actions CI workflow is introduced that executes on all branch pushes and pull requests. The workflow sets up Node.js 20 with pnpm, installs dependencies using a frozen lockfile, then runs Astro type checking, format validation, and a strict markdown audit script.

Changes

Cohort / File(s)	Summary
CI Workflow Configuration .github/workflows/ci.yml	Introduces a new check job on ubuntu-latest that runs quality gates: pnpm and Node.js 20 setup with dependency caching, frozen-lockfile installation, and three validation steps (Astro type check, format check, and strict markdown audit).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a CI workflow that performs format checks and markdown audits on every push and PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch preview/add-ci-workflow

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[netlify]

✅ Deploy Preview for scalekit-starlight ready!

Name	Link
🔨 Latest commit	a9b7632
🔍 Latest deploy log	https://app.netlify.com/projects/scalekit-starlight/deploys/69ef01bec4da6f00080330c4
😎 Deploy Preview	https://deploy-preview-635--scalekit-starlight.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[saif-at-scalekit]

Closing this PR as it falls short of the intended objective. The CI pipeline should trigger a full development build and surface any resulting errors, not just run local checks.