Adding an AGENTS.MD file #8134
Open
Adding an AGENTS.MD file #8134
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
5 tasks
mirnawong1
reviewed
Nov 5, 2025
mirnawong1
reviewed
Nov 5, 2025
mirnawong1
reviewed
Nov 5, 2025
|
|
||
| #### When to Use Code Font | ||
| Use backticks for: | ||
| - Source code (SQL, YAML, JavaScript) |
Contributor
There was a problem hiding this comment.
Suggested change
| - Source code (SQL, YAML, JavaScript) | |
| - Source code (SQL, YAML, JavaScript, JSON, Python, Jinja) |
mirnawong1
reviewed
Nov 5, 2025
|
|
||
| This guide provides AI agents with essential rules and patterns for making editorial changes to the dbt documentation repository. These guidelines are derived from the [content style guide](contributing/content-style-guide.md). | ||
|
|
||
| ## Quick Reference |
Contributor
There was a problem hiding this comment.
what is this section for?
mirnawong1
reviewed
Nov 5, 2025
| - Orchestrator | ||
| - Semantic Layer | ||
| - Copilot | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| ### Tone and clarity | |
| - Use active voice, avoid passive voice. | |
| - Write in a friendly but professional tone. | |
| - Keep sentences short (ideally under 20 words). | |
| - Prefer plain English over jargon. | |
| - Avoid unnecessary qualifiers (just, simply, easily). | |
mirnawong1
reviewed
Nov 5, 2025
| - Copilot | ||
|
|
||
| ### Text Formatting | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| #### Headings | |
| - Use sentence case for all headings. | |
| - Use `##` for section headings within a page; avoid `#`. | |
| - Do not end headings with punctuation. |
mirnawong1
reviewed
Nov 5, 2025
| - Copilot | ||
|
|
||
| ### Text Formatting | ||
|
|
Contributor
There was a problem hiding this comment.
ok i see its a intro section
Suggested change
| Use consistent Markdown formatting to improve readability, accessibility, and editorial quality. Formatting should reflect context—not just visual style. | |
Co-authored-by: Mirna Wong <[email protected]>
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.
What are you changing in this pull request and why?
Adds an AGENTS.md file
Checklist