Skip to content

docs: define general naming conventions - #415

Closed
vishr wants to merge 1 commit into
mainfrom
docs/naming-canon
Closed

vishr wants to merge 1 commit into
mainfrom
docs/naming-canon

Conversation

@vishr

@vishr vishr commented Nov 4, 2026

Copy link
Copy Markdown
Member

Summary

Add general naming guidance for code, configuration, schemas, APIs, tools, and user-facing terminology. Judge concision within the caller's context while preserving distinctions that affect correct use.

 AGENTS.md
+  Naming conventions
   Configuration conventions
   ...
   API and MCP naming

Existing interface-specific rules and contract-change requirements continue to apply.

Evidence

  • Before: Naming guidance covered configuration and API/MCP interfaces without a general rule for contextual concision.
    After: Four general rules cover context, consistent terminology, behavioral accuracy, language conventions, external contracts, and the justification for renaming.
  • git diff --check and typos AGENTS.md pass.
  • The full just check pre-push suite passes, including Go tests, 1,466 UI tests, generated documentation checks, and the site build.

Merge Danger

Door: two-way

Blast Radius: documentation

Changes agent guidance only; existing tool names, routes, and runtime behavior remain unchanged.

@vishr vishr closed this Nov 4, 2026
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