Skip to content

Update help_bits_learn.md#34636

Open
dgreen15 wants to merge 2 commits intomasterfrom
dgreen15/adding-bitsmd-docs
Open

Update help_bits_learn.md#34636
dgreen15 wants to merge 2 commits intomasterfrom
dgreen15/adding-bitsmd-docs

Conversation

@dgreen15
Copy link
Contributor

@dgreen15 dgreen15 commented Feb 17, 2026

What does this PR do? What is the motivation?

Adds a section on a new feature, bits.md

Merge instructions

Merge readiness:

  • [ x] Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

Can you help make sure the markdown file example is formatted correctly? It looks strange on the preview. I copied a code block formatter from another page

@dgreen15 dgreen15 requested a review from a team as a code owner February 17, 2026 15:00
@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some feedback! Love this page/content, btw. Thanks for drafting!


### Bits.md

bits.md is a markdown file that provides specific context to the agent on your environment. It acts as lightweight, structured guidance to improve investigation accuracy, query construction, and terminology alignment. Include team knowledge such as tagging conventions, architectural patterns, glossary, and investigation best practices.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
bits.md is a markdown file that provides specific context to the agent on your environment. It acts as lightweight, structured guidance to improve investigation accuracy, query construction, and terminology alignment. Include team knowledge such as tagging conventions, architectural patterns, glossary, and investigation best practices.
`bits.md` is a Markdown file that provides structured context about your environment to the agent. It serves as lightweight guidance to improve investigation accuracy, query construction, and terminology alignment. Include team-specific knowledge such as tagging conventions, architectural patterns, glossary terms, and investigation best practices.

bits.md is a markdown file that provides specific context to the agent on your environment. It acts as lightweight, structured guidance to improve investigation accuracy, query construction, and terminology alignment. Include team knowledge such as tagging conventions, architectural patterns, glossary, and investigation best practices.

{{< callout url="http://datadoghq.com/product-preview/bits-ai-sre-pilot-features" >}}
Bits.md is in Preview. Click <strong>Request Access</strong> to join the Preview program.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Bits.md is in Preview. Click <strong>Request Access</strong> to join the Preview program.
<b>Bits.md</b> is in Preview. Click <strong>Request Access</strong> to join the Preview program.

Bits.md is in Preview. Click <strong>Request Access</strong> to join the Preview program.
{{< /callout >}}

#### Sample Bits.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Sample Bits.md
#### Sample bits.md

#### Sample Bits.md
{{< code-block lang="yaml" filename="bits.md" collapsible="true" >}}

## Scope Rules
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Scope Rules
## Scope rules


---

## Tag & Naming Conventions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Tag & Naming Conventions
## Tag and naming conventions


## Tag & Naming Conventions

### Environment Normalization
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Environment Normalization
### Environment normalization


---

### Service Name Normalization
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Service Name Normalization
### Service name normalization


---

# Kubernetes Quick Checks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Kubernetes Quick Checks
# Kubernetes quick checks


---

# Known Noise / False Positives
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Known Noise / False Positives
# Known noise and false positives


{{< img src="bits_ai/bits_ai_sre_step_feedback.png" alt="A research step with options to provide feedback" style="width:100%;" >}}

### Bits.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content within this section is solid. However, I'm struggling a bit with the overall page flow. It seems abrupt to go from the top of the page to this new Bits.md section. I propose:

Bits improves over time based on the feedback and guidance you provide. You can help it produce faster, more accurate investigations in three ways:

- Review and correct investigation results  
- Guide how it investigates your environment  
- Manage the memories it creates  

## Provide feedback on investigations

At the end of an investigation...
... and then the rest of the content of that top part of the page ... 

## Configure proactive guidance with bits.md

In addition to reviewing investigations after they complete, you can proactively guide how Bits investigates your environment by creating a `bits.md` file.

... and then the rest of the bits.md content ... 

## Manage memories

... manage memories content ...

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.

2 participants