Skip to content

Commit f25bbdf

Browse files
committed
chore: add static webpage
1 parent 5a9fb9f commit f25bbdf

File tree

5 files changed

+1116
-0
lines changed

5 files changed

+1116
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ When using the [ScopeLift Foundry template](https://github.com/ScopeLift/foundry
1818
1. Install the [rust toolchain](https://www.rust-lang.org/tools/install)
1919
2. Run `cargo install scopelint`
2020

21+
If you prefer a more visual overview with examples and CI snippets, you can also browse the static site under [`docs/`](./docs), which is designed to be served via GitHub Pages.
22+
2123
## Usage
2224

2325
Once installed there are four commands:

docs/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ScopeLint static site
2+
3+
This directory contains a small, static marketing/docs page for ScopeLint. It is designed to be served directly via GitHub Pages.
4+
5+
## Structure
6+
7+
- `index.html` – single page with hero, why, features, usage, examples, CI, and FAQ sections.
8+
- `styles.css` – global styles for layout, typography, and cards/code blocks.
9+
- `main.js` – light progressive enhancement (smooth scrolling between sections).
10+
11+
## Hosting with GitHub Pages
12+
13+
To serve this site at `<username>.github.io/scopelint` or a custom domain:
14+
15+
1. In the GitHub repository settings for `scopelint`, open **Pages**.
16+
2. Set the **Source** to `Deploy from a branch` and choose the default branch and `/docs` folder.
17+
3. Save. GitHub will build and host the contents of this directory as a static site.
18+
19+
If you later point a custom domain such as `scopelint.dev` at GitHub Pages, you can add a `CNAME` file in this directory with the domain name as the only line. Until then, no extra configuration is required.
20+

0 commit comments

Comments
 (0)