https://github.com/compilet-dev/agent-skill-uselink
Agent skills for publishing engineering docs, repo summaries, PR digests, changelogs, API docs, onboarding guides, and specs to Uselink.
https://github.com/compilet-dev/agent-skill-uselink
agent-skills anthropic claude-code claude-skill documentation engineering-docs publishing uselink
Last synced: 9 days ago
JSON representation
Agent skills for publishing engineering docs, repo summaries, PR digests, changelogs, API docs, onboarding guides, and specs to Uselink.
- Host: GitHub
- URL: https://github.com/compilet-dev/agent-skill-uselink
- Owner: compilet-dev
- License: mit
- Created: 2026-05-27T07:22:19.000Z (25 days ago)
- Default Branch: main
- Last Pushed: 2026-05-27T07:33:11.000Z (25 days ago)
- Last Synced: 2026-05-27T09:19:19.172Z (25 days ago)
- Topics: agent-skills, anthropic, claude-code, claude-skill, documentation, engineering-docs, publishing, uselink
- Homepage: https://uselink.app
- Size: 113 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Uselink Skills for Claude Code
Agent skills that publish engineering artifacts to [uselink](https://uselink.app) -- shareable docs in seconds, no deploy pipeline needed.
Each skill follows the same pattern: **gather data -> generate HTML -> publish via CLI -> return shareable link.**
## What is Uselink?
[uselink](https://uselink.app) is a platform for publishing Markdown and HTML to a clean, shareable URL. Paste your AI-generated docs, specs, or reports, publish in seconds, and share the link with stakeholders who can read and comment -- no repo access needed.
## Prerequisites
### 1. Create a Uselink account
Sign up at [uselink.app](https://uselink.app) (free tier available -- 3 published docs, no credit card required).
### 2. Generate an API key
1. Log in to [uselink.app](https://uselink.app)
2. Go to **Settings** > **API Keys**
3. Click **Create API Key**
4. Copy the key (starts with `ulk_`)
### 3. Install and configure the CLI
```bash
# Install the CLI globally
npm install -g uselink
# Save your API key (interactive prompt)
uselink login
```
When prompted, paste the API key you copied from step 2.
### 4. Verify setup
```bash
which uselink # should print a path
cat ~/.uselink/config.json # should show api_key and api_url
```
If both commands succeed, you're ready to use the skills.
## Installation
### Via `npx skills` (Recommended)
```bash
# Install all skills
npx skills add compilet-dev/agent-skill-uselink
# Install a specific skill
npx skills add compilet-dev/agent-skill-uselink --skill uselink-repo-summary
# List available skills
npx skills add compilet-dev/agent-skill-uselink --list
# Install globally (available in all projects)
npx skills add compilet-dev/agent-skill-uselink -g
```
### Via Claude Code (Manual)
```bash
git clone https://github.com/compilet-dev/agent-skill-uselink.git
cp -R agent-skill-uselink/skills/* /path/to/your-project/.claude/skills/
```
Or install from the marketplace manifest:
```bash
claude skills install ./marketplace.json
```
## Available Skills
| Skill | What it does |
|-------|-------------|
| [uselink-publish](skills/uselink-publish/) | Publish any Markdown or HTML file to uselink |
| [uselink-report](skills/uselink-report/) | Generate code review, architecture, or sprint reports and publish |
| [uselink-share-spec](skills/uselink-share-spec/) | Share planning specs from `.planning/` with stakeholders |
| [uselink-repo-summary](skills/uselink-repo-summary/) | Scan a GitHub repo and publish an architecture overview |
| [uselink-pr-digest](skills/uselink-pr-digest/) | Summarize a PR as a stakeholder-friendly page and publish |
| [uselink-changelog](skills/uselink-changelog/) | Generate release notes from git history and publish |
| [uselink-api-docs](skills/uselink-api-docs/) | Scan controllers/routes and publish API documentation |
| [uselink-onboarding](skills/uselink-onboarding/) | Generate a new-developer onboarding guide and publish |
## Typical Workflows
### 1. Share a repo with a new team member
```
/uselink-repo-summary -> architecture overview link
/uselink-onboarding -> getting-started guide link
```
Send both links -- the new hire reads them before touching the code.
### 2. Ship a release and notify stakeholders
```
/uselink-changelog -> release notes link
/uselink-pr-digest #42 -> detailed PR summary link
```
Share the changelog in Slack. Link the PR digest for anyone who wants details.
### 3. Document the API for a partner
```
/uselink-api-docs -> API reference link
```
No Swagger setup, no API gateway. Just scan the code and share.
### 4. Sprint review
```
/uselink-report -> sprint summary with commits, PRs, contributors
```
Open the link in the meeting. Everyone sees what shipped.
### 5. Code review for the PM
```
/uselink-pr-digest #87 -> "what changed and why" page
```
The PM reads plain English, not diffs.
## How Skills Work
Every skill is a `SKILL.md` file with YAML frontmatter that teaches Claude Code a specific workflow:
```
1. Check prerequisites (uselink CLI + config)
2. Gather data (git, gh, file reads)
3. Generate HTML (layout-only CSS, no hardcoded colors)
4. Write to /tmp/uselink--.html
5. Run: uselink publish --title "..." --format html
6. Return the shareable URL
```
### Theme compatibility
Published HTML documents adapt to uselink's light/dark mode automatically. The skill templates use **layout-only CSS** (padding, margins, borders, border-radius) with no hardcoded `background` or `color`. uselink's viewer injects theme-adaptive styles that handle both modes.
### Invoke a skill
```
/uselink-repo-summary
/uselink-changelog
/uselink-pr-digest #42
```
Or just describe what you want -- Claude matches the right skill:
```
"Summarize this repo and share it with the PM"
"Generate release notes for this week"
"Create API docs and publish them"
```
## Contributing
- Each skill is one folder under `skills/` with a `SKILL.md`
- Skills must check prerequisites before publishing
- **Never set `background` or `color` in published HTML** -- uselink's viewer handles theming
- Use `opacity` for muted text, `rgba(128,128,128,0.2)` for borders
- All repo-sourced strings must be HTML-escaped
- Include a `## Gotchas` section with real failure patterns
## License
MIT