Skip to content

docs: add linear and code-plan to embedded-skills index#72

Merged
initializ-mk merged 1 commit into
mainfrom
docs/sync-linear-code-plan-skills
May 20, 2026
Merged

docs: add linear and code-plan to embedded-skills index#72
initializ-mk merged 1 commit into
mainfrom
docs/sync-linear-code-plan-skills

Conversation

@initializ-mk
Copy link
Copy Markdown
Contributor

Summary

Doc sync follow-up for the two skill PRs that already merged:

These shipped without updating the user-facing index at `docs/skills/embedded-skills.md` (the `/sync-docs` plugin mapping does not cover `forge-skills/...` yet). This PR closes that gap so the docs match what's in main.

Changes

docs/skills/embedded-skills.md:

  1. Summary table — two new rows in the developer/project-management cluster:
    • linear 📋 project-management — six scripts listed
    • code-plan 🗺️ developer — two scripts listed
  2. New "Linear Skill" section covering:
    • All six tools (get_issue, search_issues, list_my_issues, get_workflow_states, update_issue_state, add_comment)
    • The "call get_workflow_states before update_issue_state" hard rule
    • One-comment-per-action etiquette and the read/comment/transition-only scope (no deletes)
    • The no-Bearer prefix auth gotcha that surfaced during PR feat(skills): add linear embedded skill (closes #66) #67 live testing
    • Workflow cross-references into code_plan and github
  3. New "Code Plan Skill" section covering:
    • Both tools — code_plan_create (one LLM call) vs code_plan_validate (filesystem audit, no LLM)
    • Repo-signal sampling: tree + manifests + 4 KB README, bounded at 256 KB
    • repo_too_large escape behaviour
    • Plan-then-execute contract (high-complexity or risks → present to user first)
    • Schema validation with one retry, error envelope on second failure
    • ANTHROPIC_API_KEY / OPENAI_API_KEY one_of provider selection, PLAN_MODEL override

Test plan

  • Doc link checker (verbatim from .github/workflows/docs-links.yaml) passes — 37 files checked, no broken relative links
  • All new internal anchors (#code-plan-skill, #github-skill) resolve

Out of scope

Why a separate PR

PR #67 and PR #69 are already merged. The `/sync-docs` plugin's mapping table doesn't include `forge-skills/...`, so the docs missed the train. This PR is the smallest possible fix — pure docs, no code.

Mirrors the SKILL.md contracts merged via PR #67 (linear) and PR #69
(code-plan) into the user-facing docs at docs/skills/embedded-skills.md.

- Summary table gets two new rows in the developer/project-management
  cluster, with full script lists for each.
- New "Linear Skill" section covering the six tools, the
  get_workflow_states → update_issue_state hard rule, the
  one-comment-per-action etiquette, the no-Bearer-prefix auth gotcha
  that bit us in PR #67 follow-up, and the ticket-driven workflow
  cross-reference into code_plan_create and github.
- New "Code Plan Skill" section covering the two tools (LLM-call vs
  filesystem audit), repo-signal sampling at 256 KB, the
  repo_too_large escape, the plan-then-execute contract that downstream
  code-writing tool calls must match, and the schema-validation retry.

No code or SKILL.md changes — pure docs sync. README is unchanged
(it only links to docs/skills/writing-custom-skills.md, not to this
file directly, so no top-level index update is needed). PR #71's
github-skill ticket-driven update will be doc-synced separately into
the same file via that PR's branch.
@initializ-mk initializ-mk merged commit 5bbcd21 into main May 20, 2026
10 checks passed
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