Skip to content

chore: add static webpage #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thelostone-mc wants to merge 4 commits into
base: main
Choose a base branch
from
Open

chore: add static webpage #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f25bbdf
chore: add static webpage
thelostone-mc Mar 9, 2026
ca124fc
chore: clippy fix
thelostone-mc Mar 10, 2026
1406218
Fix mobile overflow in docs site
garyghayrat Jun 2, 2026
83ab683
Stabilize CI on stable Rust
garyghayrat Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
toolchain: stable
override: true
- run: cargo --version --verbose
- run: cargo build --release --all-features
Expand All @@ -27,7 +27,7 @@ jobs:
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
toolchain: stable
override: true
- uses: foundry-rs/foundry-toolchain@v1
- run: cargo test --locked --all-features
Expand All @@ -39,7 +39,7 @@ jobs:
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
toolchain: stable
override: true
components: rustfmt

Expand All @@ -51,8 +51,6 @@ jobs:

- name: cargo doc
uses: actions-rs/cargo@v1
env:
RUSTDOCFLAGS: "-D rustdoc::missing_doc_code_examples"
with:
command: doc
args: --workspace --all-features --no-deps --document-private-items
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ When using the [ScopeLift Foundry template](https://github.com/ScopeLift/foundry
1. Install the [rust toolchain](https://www.rust-lang.org/tools/install)
2. Run `cargo install scopelint`

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.

## Usage

Once installed there are four commands:
Expand Down
20 changes: 20 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# ScopeLint static site

This directory contains a small, static marketing/docs page for ScopeLint. It is designed to be served directly via GitHub Pages.

## Structure

- `index.html` – single page with hero, why, features, usage, examples, CI, and FAQ sections.
- `styles.css` – global styles for layout, typography, and cards/code blocks.
- `main.js` – light progressive enhancement (smooth scrolling between sections).

## Hosting with GitHub Pages

To serve this site at `<username>.github.io/scopelint` or a custom domain:

1. In the GitHub repository settings for `scopelint`, open **Pages**.
2. Set the **Source** to `Deploy from a branch` and choose the default branch and `/docs` folder.
3. Save. GitHub will build and host the contents of this directory as a static site.

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.

Loading
Loading