Skip to content

Prioritize style guide over matching existing content in AGENTS.md#2305

Open
anastasiaguspan wants to merge 1 commit intomainfrom
agents-docs-1986
Open

Prioritize style guide over matching existing content in AGENTS.md#2305
anastasiaguspan wants to merge 1 commit intomainfrom
agents-docs-1986

Conversation

@anastasiaguspan
Copy link
Contributor

@anastasiaguspan anastasiaguspan commented Mar 17, 2026

addl notes on changes in ticket https://wandb.atlassian.net/browse/DOCS-1986

Summary

  • Consolidates seven "match existing content" / "surrounding content" mentions into one clear directive: follow the style guide for all new and edited content, fix style issues within the section you're editing, and save broad refactors for dedicated PRs.
  • Reframes the style hierarchy so that this style guide and the Google Developer Style Guide are the primary authorities, rather than "match existing content first."
  • Clarifies list capitalization: "Start each list item with a capital letter unless the first word is a case-sensitive term like a code identifier." (I added this because it got it wrong yesterday on mine)
  • Adds weave.init pattern guidance.

Why

The repeated "match existing content even if it's not perfect" messaging risked agents replicating style errors from older content instead of following the style guide. This change makes the style guide the source of truth while still discouraging drive-by style refactors in content PRs.

Made with Cursor

Consolidate and reframe the repeated "match existing content" messaging
so that the style guide is the primary authority for all new and edited
content. Agents should read surrounding content for context but not
replicate style errors. Broad style refactors remain separate PRs.

Also clarifies list capitalization rule and adds weave.init pattern.

Made-with: Cursor
@github-actions
Copy link
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
AGENTS.md AGENTS

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 72ff504 at 2026-03-17 21:37:29 UTC

@github-actions
Copy link
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-agents-docs-1986.mintlify.app

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