diff --git a/.claude/review-prompt.md b/.claude/review-prompt.md new file mode 100644 index 000000000..cc737645c --- /dev/null +++ b/.claude/review-prompt.md @@ -0,0 +1,4 @@ +# Claude output format + +- Use inline comments at the relevant lines for specific issues. +- Use a top-level comment for the summary, severity-tagged finding list, AGENTS.md / writing_style_guide.md compliance check, and the verification assessment. diff --git a/.github/codex/pr-review.prompt.md b/.github/codex/pr-review.prompt.md new file mode 100644 index 000000000..fef52dba8 --- /dev/null +++ b/.github/codex/pr-review.prompt.md @@ -0,0 +1,5 @@ +# Codex output format + +- Read `./.github/codex/pr-review-context.md` for PR metadata and the diff commands. +- Return a markdown PR comment starting with `## Codex Review`. +- Tag each finding with a severity (P0 / P1 / P2), file path, and line number when known confidently. diff --git a/.github/pi/pr-review.prompt.md b/.github/pi/pr-review.prompt.md new file mode 100644 index 000000000..92f128c6b --- /dev/null +++ b/.github/pi/pr-review.prompt.md @@ -0,0 +1,6 @@ +# Pi output format + +- Read `./.github/pi/pr-review-context.md` for PR metadata and the diff commands. +- Return a markdown PR comment starting with `## Pi Review`. +- Tag each finding with a severity (P0 / P1 / P2), file path, and line number when known confidently. +- Output ONLY the final review markdown — no preamble, no thinking, no tool transcripts. diff --git a/.github/review-prompt-shared.md b/.github/review-prompt-shared.md new file mode 100644 index 000000000..3345a9196 --- /dev/null +++ b/.github/review-prompt-shared.md @@ -0,0 +1,57 @@ +# Pull request review — shared policy (windmilldocs) + +You are reviewing a GitHub pull request for the **windmilldocs** repository (the public Windmill documentation site, built with Docusaurus). Apply this policy alongside your tool's output requirements. + +## Read the project rules first + +- Read `AGENTS.md` (repo root), `CLAUDE.md`, and `writing_style_guide.md` before reviewing — they are the canonical contributor guide for documentation. +- Quote the exact rule from `AGENTS.md` or `writing_style_guide.md` when flagging a violation. + +## Review policy + +- Only report issues you are confident are real and introduced by this pull request. +- Focus on factual mistakes, broken links/anchors, MDX/markdown issues, missing or invalid frontmatter, sidebar misregistration, and clear `AGENTS.md` / `writing_style_guide.md` violations. +- Do not report style nits, speculative concerns, pre-existing issues, or anything Docusaurus's own build (`npm run build`) would obviously catch (build errors are caught by the `check docs build` workflow). +- Self-validate each finding before posting: "is this definitely a real issue?" If uncertain, discard it. +- Read additional files only when the diff is not enough to validate a finding. +- Do not modify any files. + +## Severity triage + +Tag each finding with a severity. Always report P0 and P1. Report P2 only when the diff invites it (a new docs page, a new section in `sidebars.js`, a new landing page, a new component, or a meaningful restructure). + +- **P0** — factually wrong claim about a Windmill feature that could mislead users (e.g. wrong CLI flag, wrong default value, wrong tier gating like "this is free" when it's Enterprise), broken link to a critical onboarding page, secrets/credentials accidentally committed, security misinformation. +- **P1** — broken internal link or anchor, missing/invalid frontmatter `description`, page not registered in `sidebars.js` when it should be, image referenced but missing from the directory, code example that won't run as written, Enterprise/Cloud/Pro feature not labeled as such on first mention, missing `[Enterprise Edition](/pricing)` link on first mention of EE on the page. +- **P2** — `AGENTS.md` / `writing_style_guide.md` violations (em dashes, bold misuse, title case in headings, marketing-style language, missing backlinks on first mention of a concept), JSON-LD missing on a non-doc page that needs it, `description` outside the recommended length (120–160 chars for docs/changelog, up to ~300 for blog/case studies), missing `textAnswer` field on FAQ entries, image only in PNG (no WebP) or vice versa, file/folder naming that doesn't follow the underscore + numeric prefix convention. + +## Documentation-specific checks + +For each new or significantly edited `.md` / `.mdx` page in the diff, verify: + +- (a) Frontmatter has a `description` field, between 120–160 chars for docs/changelog, ideally question-based ("How do I ...?"). +- (b) The first mention of "Enterprise Edition" / "EE" links to `/pricing`. Subsequent mentions on the same page do not need to be linked. +- (c) Internal links use **relative paths** (e.g. `../../8_triggers/index.mdx`) on first mention of a concept, and external links are absolute URLs. +- (d) If the page introduces a new feature, a backlink exists from related main pages (and ideally a `DocCard` component on the parent index). +- (e) If a new page is added under `docs/`, it appears in `sidebars.js`. If it's a major feature, it should also be considered for `docs/core_concepts/index.mdx` and `src/components/pricing/FeatureList.js` (when EE/Cloud/Team). +- (f) Code blocks specify a language (`ts`, `python`, `bash`, etc.). +- (g) No em dashes ('—') in prose — use sentences without them or '-' instead. +- (h) Headings use sentence case ('Like this'), not title case ('Like This'). No bold in headings or titles. No HTML colour styling on titles. +- (i) Images live in the same directory as the related MDX file, with both PNG and optimized WebP versions, and meaningful filenames. + +For new non-doc pages (landing/marketing, case studies, product pages, FAQ sections), also verify the JSON-LD `