Skip to content

Docs: last single-plugin tidy — intro, section heading, site description #54

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

Merged
mmcky merged 2 commits into from
Aug 25, 2026
Merged

Docs: last single-plugin tidy — intro, section heading, site description #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6282d4
Docs: last single-plugin tidy — intro, section heading, site description
mmcky Aug 25, 2026
1ab4b19
Docs: Contributing covers docs PRs too, and names the catalogue path
mmcky Aug 25, 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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A [Claude Code plugin marketplace](https://code.claude.com/docs/en/plugin-marketplaces) housing QuantEcon's shared agent skills and their supporting scripts.

Each plugin bundles one area of work — a skill (the instructions Claude follows) plus the deterministic scripts it drives — so the same versioned toolkit works locally for authors and RAs, and headlessly in CI.
One plugin, `qe`, bundles the skills (the instructions Claude follows) with the deterministic scripts they drive, so the same versioned toolkit works locally for authors and RAs, and headlessly in CI.

📖 **[quantecon.github.io/skills](https://quantecon.github.io/skills)** — the documentation, rendered and navigable. It is built from the files in this repository, so reading either one gets you the same content.

Expand Down Expand Up @@ -30,7 +30,7 @@ Start with [docs/using-skills.md](docs/using-skills.md) to use the skills, and [

### Automatic (lecture repos)

Lecture repositories opt in by checking the following into their `.claude/settings.json`. Anyone who opens the repo and trusts it gets the marketplace and plugins installed automatically — no commands to run:
Lecture repositories opt in by checking the following into their `.claude/settings.json`. Anyone who opens the repo and trusts it gets the marketplace and plugin installed automatically — no commands to run:

```json
{
Expand Down Expand Up @@ -70,6 +70,6 @@ The official action accepts the marketplace and plugin directly:

## Contributing

Open a PR adding or modifying a plugin directory and registering it in `.claude-plugin/marketplace.json`. The whole workflow — repo layout, conventions, local testing, validation (`python scripts/validate.py`), and the version-bump-plus-changelog rule that CI enforces on every plugin change — is in [docs/developing-skills.md](docs/developing-skills.md), and the repo-wide ground rules are in [AGENTS.md](AGENTS.md).
Open a PR — repo-level docs and plugin changes alike. A change under `qe/` bumps the plugin version in both `qe/.claude-plugin/plugin.json` and its entry in `.claude-plugin/marketplace.json`; the whole workflow — repo layout, conventions, local testing, validation (`python scripts/validate.py`), and the version-bump-plus-changelog rule that CI enforces — is in [docs/developing-skills.md](docs/developing-skills.md), and the repo-wide ground rules are in [AGENTS.md](AGENTS.md).

Broader context for this repository: [QuantEcon/meta#304](https://github.com/QuantEcon/meta/issues/304) (toolkit proposal) and [QuantEcon/meta#335](https://github.com/QuantEcon/meta/issues/335) (benchmarking programme).
2 changes: 1 addition & 1 deletion docs/using-skills.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Two ways, equivalent:
- **Evidence, not vibes.** Reports cite rule IDs, `file:line` locations, and measured numbers. The benchmark skill goes further: its scores are computed by a deterministic engine from recorded evidence — the session shows the full derivation.
- **The same skill works pre-PR and in review.** Run it on your working copy before opening a PR (catch issues early), or point it at an open PR (consistent review).

## The plugins
## The skills

Everything that registers in your slash menu — one plugin, five skills. Since `qe` 0.6.0 every entry is a skill that actually runs — an unbuilt skill lives only as the plan in its family's tracking issue (the style-check family, for example, is [skills#3](https://github.com/QuantEcon/skills/issues/3)). [CATALOG.md](../CATALOG.md) is the stricter list: merged, operational, *and* stating how far each has been validated.

Expand Down
4 changes: 2 additions & 2 deletions myst.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ project:
title: QuantEcon Skills
description: >-
QuantEcon's shared Claude Code skills and the deterministic scripts they
drive — style checks for authors, acceleration evaluation, and bulk
repository audits.
drive — PR review support for authors, acceleration triage and review,
bulk repository audits, and cross-session work-plan tooling.
github: https://github.com/QuantEcon/skills
toc:
- file: README.md
Expand Down
Loading