Skip to content

PRDCT-545: add docs-revamp house style + process to CLAUDE.md - #1000

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
docs/agent-guidance-house-style
Closed

Iamfle4ka wants to merge 1 commit into
mainfrom
docs/agent-guidance-house-style

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Bakes the durable, repo-wide conventions from the Apps/Transformations revamp into agent guidance so future agents follow them (matches the pattern of keeping house style in CLAUDE.md).

Adds two sections to CLAUDE.md:

  • Docs authoring (house style) — Diátaxis one-type-per-page, action-first how-tos, fuller overviews, reference with limits at the bottom, active/sentence-case voice, connector/component not "plugin", source-derived reference, Kai-as-replacement, UI-locator screenshots → public/<section>/, redirects with structural PRs, wrap wide tables, keep/delete by supported-status+code not traffic.
  • Docs revamp process — four-stage pipeline (structure → form → accuracy → Kai-weaving), structure/form agent-decided vs facts/deletions owner-or-code-gated (VERIFY/TODO(human-review)), content conservation, and current guardrails (no E2B-as-hosting / Streamlit-retired / pricing / semantic-layer claims).

Also: rewords the screenshot rule to distinguish debug shots (/tmp, never committed) from doc UI-locator images (public/<section>/, committed) — the old wording read as a blanket ban.

Stakeholder-specific likes/dislikes and the paste-ready prompt block stay local (gitignored apps-section/ bundle), not in the repo. One file changed (+33/-2).

🤖 Generated with Claude Code

Bake the durable, repo-wide conventions from the Apps/Transformations revamp into
agent guidance: Diátaxis one-type-per-page, action-first how-tos, limits-at-bottom,
Kai-as-replacement, source-derived reference, UI-locator screenshots committed to
public/<section>/, redirects with structural PRs, the four-stage pipeline, and
owner/code-gated facts. Also reword the screenshot rule to distinguish debug shots
(/tmp) from committed doc images. Stakeholder-specific notes stay local, not here.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jul 8, 2026 12:36pm

Request Review

@Iamfle4ka Iamfle4ka changed the title docs: add docs-revamp house style + process to CLAUDE.md PRDCT-545: add docs-revamp house style + process to CLAUDE.md Jul 15, 2026
@linear-code

linear-code Bot commented Jul 15, 2026

Copy link
Copy Markdown

PRDCT-545

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Superseded by #1086, which consolidates the four PRs that were all editing CLAUDE.md / AGENTS.md / .gitignore (#1000, #1065, #1057, #1076).

Everything here survived: the Docs authoring (house style) and Docs revamp process sections are in #1086 verbatim. The Screenshots bullet was the one real conflict — #1057 rewrote the same line and dropped the public/<section>/ half — so #1086 carries a merged version that keeps this PR's debug-vs-committed distinction and #1057's shoot.mjs warning.

Closing as a duplicate; the branch stays on the remote.

@Iamfle4ka Iamfle4ka closed this Aug 5, 2026
jordanrburger pushed a commit that referenced this pull request Aug 5, 2026
Consolidates four overlapping PRs that all edited the same three files:
#1000 (docs house style + revamp process), #1065 (dev→help migration
rules), #1057 and #1076 (Vercel-is-production, .claude symlink fix).

Two conflicts are resolved by hand rather than by merge order: the
Screenshots bullet, which #1000 and #1057 rewrote in different
directions, and the Claude-specific notes list, where #1057 dropped
three bullets #1000 kept.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview — 25c895ca Deployed Jul 8, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant