feat: add docs-accept-quest authoring skill - #115
Open
florent-leborgne wants to merge 2 commits into
Open
Conversation
Issue-to-PR workflow with first-run path setup for docs-content, pitfalls checklist, and editorial preferences so writers can keep existing local files. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Skill Quality Reviewdocs-accept-questOverall: A comprehensive, well-structured multi-phase workflow skill that encodes Elastic-specific documentation conventions and processes with high specificity and actionability. Strengths:
Issues:
Suggestions:
|
Contributor
Skill Eval Resultsdocs-accept-quest
Overall: 14/14 expectations passed (100%) Assessment: The skill instructions clearly and explicitly address all eval scenarios:
|
6 tasks
Quest intake is often docs-content, but edits and PRs can land in kibana, elasticsearch, or other product docs trees. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
docs-accept-quest, an end-to-end authoring skill that turns an Elastic documentation GitHub issue into a draft PR in the repo that owns the target pages. Every factual claim must be traceable to product source or another authoritative evidence — not issue-body prose alone.Not docs-content-only. Quests usually start from an
elastic/docs-contentissue, but product-repo routing can put the edit (or a companion PR) inkibana,elasticsearch, or another in-product docs tree. The skill confirms ownership before branching.What the skill does
Given a docs issue (
elastic/docs-content#Nis typical; other repos and full URLs are accepted), the skill runs this pipeline:docs-contentclone (for corpus search and docs-content worktrees), pitfalls checklist, and editorial preferences (env vars, local YAML config, or first-run questions). Existing files stay in place; the skill only records paths.origin/mainin the target docs repo; write against editorial preferences +docs-applies-to-tagging(when installed) + style guide / MyST.Companion catalog skills (
docs-applies-to-tagging,docs-content-type-checker,docs-page-opening-optimizer,docs-check-style) are optional: invoke when installed, do not fail if missing.Bundled reference files
pitfalls.examples.mdeditorial-preferences.example.mdThese examples are the files I use today in my day-to-day docs workflow (shared as starters). Writers can copy them on first run, or point Phase 0 at their own paths and keep using existing files without moving them.
Paths persist in
~/.config/elastic-docs/docs-accept-quest.local.yml(or env vars / a workspacedocs-accept-quest.local.yml).Writer setup
On first run the skill resolves:
$DOCS_CONTENT_ROOTdocs-contentclone (still needed for corpus search when the PR opens elsewhere)$DOCS_PITFALLS_PATH$EDITORIAL_PREFERENCES_PATHLater runs skip Phase 0 when config or env vars are present. For non-docs-content target repos, the skill asks for that clone path when branching.
Test plan
/docs-accept-quest(or equivalent) with no local config — confirm it asks for the three paths and can seed from the bundled examplesdocs-applies-to-tagging, etc.) are optional when missing