Move docs to Starlight

Author: fvictorio

.github/workflows/deploy-docs.yml

@@ -0,0 +1,33 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - name: Install, build, and upload your site
+        uses: withastro/action@v3
+        with:
+          path: docs
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,3 +1,4 @@
+.astro/
 node_modules/
 dist/
 *.tsbuildinfo

.prettierignore

@@ -1,2 +1,3 @@
 package.json
 pnpm-lock.yaml
+starlight/

.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["astro-build.astro-vscode"],
+  "unwantedRecommendations": []
+}

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "name": "Development server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

README.md

@@ -1,5 +1,7 @@
 # Slippy
 
+[Docs](https://fvictorio.github.io/slippy)
+
 Slippy is a linter for Solidity that's simple, powerful, and thoughtfully built.
 
 ## Installation
@@ -24,11 +26,11 @@ npx slippy "contracts/**/*.sol"
 
 # Why Slippy?
 
-You can read a more detailed [comparison between Slippy and Solhint](/docs/slippy-vs-solhint.md), but here's a summary:
+You can read a more detailed [comparison between Slippy and Solhint](https://fvictorio.github.io/slippy/guides/slippy-vs-solhint), but here's a summary:
 
 - A single, flexible configuration that lets you easily enable or disable rules for specific parts of your codebase
-- A unified [`naming-convention`](/docs/rules/naming-convention.md) rule
-- A more accurate [`no-unused-vars`](/docs/rules/no-unused-vars.md) rule
+- A unified [`naming-convention`](https://fvictorio.github.io/slippy/rules/naming-convention) rule
+- A more accurate [`no-unused-vars`](https://fvictorio.github.io/slippy/rules/no-unused-vars) rule
 - Unused comment directives like `// slippy-disable-line` are reported
 - No formatting rules
 - Semantic versioning
@@ -46,40 +48,8 @@ module.exports = {
 };
 ```
 
-For more details on configuring Slippy, including advanced features like cascading configurations, file ignores, and comment directives, see the [configuration documentation](/docs/config.md).
+For more details on configuring Slippy, including advanced features like cascading configurations, file ignores, and comment directives, see the [configuration documentation](https://fvictorio.github.io/guides/configuration).
 
 # Rules
 
-_Rules that have a 🔧 next to them can be automatically fixed by running Slippy with the `--fix` flag._
-
-- [`compatible-pragma`](/docs/rules/compatible-pragma.md): checks that the minimum supported pragma version is compatible with the features used in the file.
-- [`curly`](/docs/rules/curly.md): enforces the use of curly braces for all control structures.
-- [`explicit-types`](/docs/rules/explicit-types.md): enforces or forbids the use of aliases like `uint` instead of `uint256`. 🔧
-- [`id-denylist`](/docs/rules/id-denylist.md): allows you to specify a list of forbidden identifiers.
-- [`imports-on-top`](/docs/rules/imports-on-top.md): enforces that all import statements are at the top of the file.
-- [`max-state-vars`](/docs/rules/max-state-vars.md): limits the number of state variables in a contract.
-- [`named-return-params`](/docs/rules/named-return-params.md): enforces that functions with multiple return parameters use named return parameters.
-- [`naming-convention`](/docs/rules/naming-convention.md): enforces a naming convention across the codebase.
-- [`no-console`](/docs/rules/no-console.md): forbids the use of `console.log` and the import of `console.sol`.
-- [`no-default-visibility`](/docs/rules/no-default-visibility.md): forbids the use of default visibility for state variables. 🔧
-- [`no-duplicate-imports`](/docs/rules/no-duplicate-imports.md): forbids importing the same file multiple times.
-- [`no-empty-blocks`](/docs/rules/no-empty-blocks.md): forbids blocks without statements.
-- [`no-global-imports`](/docs/rules/no-global-imports.md): forbids global imports like `import "./foo.sol"`.
-- [`no-hardcoded-gas`](/docs/rules/no-hardcoded-gas.md): disallows hardcoded gas values in call options.
-- [`no-restricted-syntax`](/docs/rules/no-restricted-syntax.md): disallows syntax patterns specified with [Slang queries](https://nomicfoundation.github.io/slang/latest/user-guide/06-query-language/01-query-syntax/).
-- [`no-send`](/docs/rules/no-send.md): forbids the use of `send` and `transfer` for sending value, in favor of using `call` with value.
-- [`no-tx-origin`](/docs/rules/no-tx-origin.md): forbids the use of `tx.origin`.
-- [`no-unchecked-calls`](/docs/rules/no-unchecked-calls.md): disallows low-level calls like `call`, `staticcall`, and `delegatecall` that don't use their return values.
-- [`no-uninitialized-immutable-references`](/docs/rules/no-uninitialized-immutable-references.md): forbids using immutable references before they are initialized.
-- [`no-unnecessary-boolean-compare`](/docs/rules/no-unnecessary-boolean-compare.md): forbids unnecessary comparisons to boolean literals.
-- [`no-unnecessary-else](/docs/rules/no-unnecessary-else.md): disallows `else` blocks following `if` statements that end with a control-flow-terminating statement (`return`, `break`, etc.)
-- [`no-unused-vars`](/docs/rules/no-unused-vars.md): detects unused variables, imports and functions.
-- [`one-contract-per-file`](/docs/rules/one-contract-per-file.md): enforces that a file contains at most one contract/interface/library definition.
-- [`private-vars`](/docs/rules/private-vars.md): enforces that all state variables are private.
-- [`require-revert-reason`](/docs/rules/require-revert-reason.md): enforces that all reverts have a reason.
-- [`sort-imports`](/docs/rules/sort-imports.md): enforces a specific order for import statements.
-- [`sort-members`](/docs/rules/sort-members.md): enforces a specific order for top-level elements and contract/interface/library members.
-- [`sort-modifiers`](/docs/rules/sort-modifiers.md): enforces a specific order for modifiers. 🔧
-- [`yul-prefer-iszero`](/docs/rules/yul-prefer-iszero.md): recommends using `iszero` instead of `eq` when comparing to the `0` literal in Yul code.
-
-Don't see a rule you need? [Open an issue](https://github.com/fvictorio/slippy/issues/new).
+You can find the full list of available rules in the [rules reference documentation](https://fvictorio.github.io/slippy/reference/rules).

docs/README.md

@@ -0,0 +1,49 @@
+# Starlight Starter Kit: Basics
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight
+```
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   └── docs/
+│   └── content.config.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

docs/astro.config.mjs

@@ -0,0 +1,40 @@
+// @ts-check
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+
+export default defineConfig({
+  site: "https://fvictorio.github.io",
+  base: "/slippy",
+  integrations: [
+    starlight({
+      title: "Slippy",
+      social: [
+        {
+          icon: "github",
+          label: "GitHub",
+          href: "https://github.com/fvictorio/slippy",
+        },
+      ],
+      sidebar: [
+        {
+          label: "Guides",
+          items: [
+            { label: "Getting started", slug: "guides/getting-started" },
+            { label: "Configuring Slippy", slug: "guides/configuration" },
+            { label: "Slippy vs Solhint", slug: "guides/slippy-vs-solhint" },
+          ],
+        },
+        {
+          label: "Reference",
+          items: [{ label: "List of rules", slug: "reference/rules" }],
+        },
+
+        {
+          label: "Rules",
+          collapsed: true,
+          autogenerate: { directory: "rules" },
+        },
+      ],
+    }),
+  ],
+});

docs/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "learning-starlight",
+  "type": "module",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "astro dev --host",
+    "start": "astro dev",
+    "build": "astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@astrojs/starlight": "^0.36.2",
+    "astro": "^5.6.1",
+    "sharp": "^0.34.2"
+  },
+  "packageManager": "pnpm@10.5.2"
+}