Skip to content

docs: add a README - #11

Merged
avifenesh merged 1 commit into
mainfrom
docs/readme-audit
Oct 31, 2026
Merged

avifenesh merged 1 commit into
mainfrom
docs/readme-audit

Conversation

@avifenesh

Copy link
Copy Markdown
Contributor

The repo had no README. This adds a short one, written from the code at HEAD.

Each fact and its source:

  • Three skills and what they cover: components.json and the description frontmatter of each skills/*/SKILL.md.
  • Install with npx skills add agent-sh/glidemq: npx skills add agent-sh/glidemq --list finds all 3 skills.
  • Not in the agentsys marketplace: agentsys .claude-plugin/marketplace.json has no glidemq entry, so agentsys install glidemq fails with "Unknown plugin". The agentsys README says the same.
  • Vendored from avifenesh/glide-mq skills/, sync and drift commands with their exit codes: AGENTS.md, skills/UPSTREAM.md, scripts/.
  • Drift check every Monday, opens an upstream-sync issue: .github/workflows/check-upstream-drift.yml (cron 0 6 * * 1).
  • npm test and agnix .: package.json scripts, ci.yml, AGENTS.md.
  • License Apache-2.0: root LICENSE (copied from upstream).

Links checked: glide-mq.dev docs and agentskills.io return 200. npmjs.com returns 403 to curl because it blocks bots.

Checks: npm test passes (17 Markdown files). agnix . reports 0 errors. Its 1 warning is the size of the vendored glide-mq-migrate-bullmq/SKILL.md, which has to be fixed upstream.

@avifenesh

Copy link
Copy Markdown
Contributor Author

Self-review (fresh context): no problems found.

Checked every claim in the new README against the branch head:

  • Skill names and coverage match components.json and each SKILL.md description.
  • Each skill has a references/ folder.
  • Not in the agentsys marketplace: .claude-plugin/marketplace.json in agentsys has no glidemq entry, and the agentsys README says the same.
  • Vendoring, sync usage [ref] (default main) and drift exit codes 0/1/2 match AGENTS.md, skills/UPSTREAM.md and scripts/.
  • Monday drift check and the upstream-sync issue match check-upstream-drift.yml (cron 0 6 * * 1).
  • The npm test description matches the test and test:links scripts.
  • LICENSE is Apache-2.0.
  • Links return 200: github.com/agent-sh, github.com/avifenesh/glide-mq, the glide-mq.dev docs and agentskills.io. Relative links skills/UPSTREAM.md and LICENSE exist.
  • No em dashes or hedging.

Outside this diff: package.json declares "license": "MIT", but the root LICENSE and the README say Apache-2.0. That belongs in a separate fix.

@avifenesh
avifenesh merged commit 8d6b274 into main Oct 31, 2026
3 checks passed
@avifenesh
avifenesh deleted the docs/readme-audit branch October 31, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant