Skip to content

Commit 030f6ed

Browse files
committed
Enhance documentation and improve README layout for Skill<span style="color:#ff6eb4">er</span>.
- Update references to the app name for consistency. - Add GitHub Pages deployment instructions to DEVELOPMENT.md. - Refine SEO-focused content in index.html for better discoverability. - Streamline layout and improve readability across multiple files.
1 parent 2cf30da commit 030f6ed

6 files changed

Lines changed: 694 additions & 276 deletions

File tree

.github/workflows/pages.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Publishes the static landing in /docs to GitHub Pages.
2+
#
3+
# Last failure (2026-04-16): configure-pages returned 404 "Get Pages site failed"
4+
# because Pages was not enabled for the repo. Fix either:
5+
# Settings → Pages → Build: GitHub Actions
6+
# or rely on enablement: true below (needs default GITHUB_TOKEN with pages: write).
7+
8+
name: Deploy docs to GitHub Pages
9+
10+
on:
11+
push:
12+
branches: ["main"]
13+
paths:
14+
- "docs/**"
15+
- ".github/workflows/pages.yml"
16+
workflow_dispatch:
17+
18+
permissions:
19+
contents: read
20+
pages: write
21+
id-token: write
22+
23+
concurrency:
24+
group: pages
25+
cancel-in-progress: true
26+
27+
jobs:
28+
deploy:
29+
environment:
30+
name: github-pages
31+
url: ${{ steps.deployment.outputs.page_url }}
32+
runs-on: ubuntu-latest
33+
steps:
34+
- uses: actions/checkout@v5
35+
36+
- name: Setup Pages
37+
uses: actions/configure-pages@v5
38+
with:
39+
enablement: true
40+
41+
- name: Upload Pages artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: ./docs
45+
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ bun install
7878
## Further reading
7979

8080
- `README.md` — product overview and install links.
81-
- `docs/DEVELOPMENT.md`deep dive on dev, DMG, updater, and GitHub Actions release.
81+
- `docs/DEVELOPMENT.md` — dev, DMG, updater, GitHub Actions release, and **GitHub Pages** for the `docs/` landing.

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# Skiller
1+
# Skill<span style="color:#ff6eb4">er</span>
22

33
![Skiller Hero Banner](docs/images/screenshots/hero.png)
44

5-
Skiller is a desktop manager for AI agent skills.
6-
Install, sync, and manage skills across multiple coding agents from one UI.
5+
Install, sync, and manage AI agent skills across your coding agents from one desktop app.
76

8-
## Why Skiller
7+
## Why Skill<span style="color:#ff6eb4">er</span>
98

109
Managing skills separately in every agent is repetitive and error-prone.
11-
Skiller gives you one control center to:
10+
Skill<span style="color:#ff6eb4">er</span> gives you one control center to:
1211

1312
- **See everything at once** — agents, installed skills, and status in one dashboard
1413
- **Install once, sync everywhere** — propagate skills across your agent stack
@@ -18,7 +17,7 @@ Skiller gives you one control center to:
1817

1918
## Supported agents
2019

21-
Skiller talks to every listed agent natively — dropping a skill into one place propagates it to all of them.
20+
Skill<span style="color:#ff6eb4">er</span> talks to every listed agent natively — dropping a skill into one place propagates it to all of them.
2221

2322
<table>
2423
<tr>
@@ -80,15 +79,15 @@ Grab the installer for your OS from the [**latest release**](https://github.com/
8079

8180
| OS | File | Notes |
8281
| --- | --- | --- |
83-
| macOS (Apple Silicon) | `stable-macos-arm64-Skiller.dmg` | Signed + notarized — opens with no Gatekeeper warnings. Open the DMG and drag Skiller to Applications. |
82+
| macOS (Apple Silicon) | `stable-macos-arm64-Skiller.dmg` | Signed + notarized — opens with no Gatekeeper warnings. Open the DMG and drag Skill<span style="color:#ff6eb4">er</span> to Applications. |
8483
| Windows (x64) | `stable-win-x64-Skiller-Setup.zip` | Extract and run `Skiller.exe`. SmartScreen may show a one-time warning — click "More info" → "Run anyway". |
8584
| Linux (x64) | `stable-linux-x64-Skiller-Setup.tar.gz` | Extract and run `bin/launcher` from the resulting folder. |
8685

8786
Every release is built and published by the CI matrix in `.github/workflows/release.yml` — tagging `vX.Y.Z` produces all three platforms automatically.
8887

8988
## Auto-updates
9089

91-
Once installed, Skiller keeps itself current:
90+
Once installed, Skill<span style="color:#ff6eb4">er</span> keeps itself current:
9291

9392
- Checks for new versions on launch, then every 6 hours in the background.
9493
- Downloads delta patches (~14 KB typical) when available; falls back to the full bundle if the patch chain breaks.
@@ -98,9 +97,7 @@ The updater points at `github.com/.../releases/latest/download`, so every tagged
9897

9998
## For Developers
10099

101-
All development, build, and debugging details were moved to:
102-
103-
- `[docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)`
100+
All development, build, and debugging details are in **[docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)**.
104101

105102
## Contributing
106103

docs/DEVELOPMENT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ Required repo **Secrets** (Settings → Secrets and variables → Actions) for m
8282

8383
Windows/Linux jobs don't need secrets; an unsigned `.exe` will just show a SmartScreen warning the first time a user runs it.
8484

85+
### Landing site — GitHub Pages
86+
87+
`.github/workflows/pages.yml` publishes the static files in `docs/` (e.g. `index.html`, `images/`) to GitHub Pages on pushes to `main` that touch `docs/**` or the workflow. You can also run the workflow manually (**Actions → Deploy docs to GitHub Pages → Run workflow**).
88+
89+
**One-time repo setup:** **Settings → Pages → Build and deployment → Source: GitHub Actions.** If Pages was never enabled, the deploy job used to fail at *Setup Pages* with `HttpError: Not Found` when calling the Pages API — enabling Actions as the source fixes that. The workflow sets `enablement: true` on `actions/configure-pages` so a first run may enable Pages automatically when permissions allow.
90+
91+
Site URL shape: `https://<owner>.github.io/<repo>/` (for this fork, owner `beautyfree` and repo name from **Settings → General**).
92+
8593
### Option 2 — Local Windows VM (Parallels / UTM / Hyper-V)
8694

8795
Inside a Windows 10/11 VM:

docs/images/skiller-mark.png

26.1 KB
Loading

0 commit comments

Comments
 (0)