feat: Scalar Docs 2.0

.github/workflows/validate-scalar-configuration.yml

@@ -0,0 +1,32 @@
+name: Validate Scalar Configuration
+
+on:
+  # push to main
+  push:
+    branches:
+      - main
+    paths:
+      - "scalar.config.json"
+      - "docs/**"
+  # pull requests
+  pull_request:
+    paths:
+      - "scalar.config.json"
+      - "docs/**"
+
+jobs:
+  validate:
+    name: Validate scalar.config.json
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: "24"
+
+      - name: Validate
+        run: npx @scalar/cli@latest project check-config

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Scalar
+Copyright (c) 2023-present Scalar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -5,11 +5,11 @@
 [![Twitter](https://img.shields.io/twitter/follow/scalar)](https://x.com/scalar)
 [![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
 
-Welcome to the Scalar Docs starter kit! This project provides you with a complete foundation to create beautiful, interactive API documentation using Scalar's powerful documentation platform.
+Welcome to the Scalar Docs Starter Kit! Deploy Markdown and OpenAPI documents from GitHub.
 
 ## Preview
 
-Use the Scalar CLI to render a live preview of your project locally:
+Use the [Scalar CLI](https://scalar.com/tools/cli/getting-started) to render a live preview of your project locally:
 
 ```bash
 npx @scalar/cli project preview
@@ -27,6 +27,10 @@ npx @scalar/cli project check-config
 
 This will verify that your `scalar.config.json` file contains valid settings and help identify any configuration issues.
 
+### GitHub Action
+
+This repository includes a GitHub Action workflow that automatically validates the configuration on every push and pull request. See [`.github/workflows/validate-scalar-configuration.yml`](./.github/workflows/validate-scalar-configuration.yml).
+
 ## Project Structure
 
 ```