Skip to content

docs: drop audit-status claim from llms.txt examples line - #407

Merged
bidzyyys merged 1 commit into
mainfrom
docs/llms-examples-neutral
Jun 23, 2026
Merged

docs: drop audit-status claim from llms.txt examples line#407
bidzyyys merged 1 commit into
mainfrom
docs/llms-examples-neutral

Conversation

@bidzyyys

@bidzyyys bidzyyys commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Examples aren't audited (high-level review only); audited-adjacent overstated it. Now just "integration examples (composition recipes)".

Summary by CodeRabbit

  • Documentation
    • Clarified documentation to better characterize examples as compilable integration examples serving as composition recipes, helping users understand how to utilize these resources as reference implementations and practical templates for building their own integrations.

Examples are not audited (only a high-level flow review) and carry unaudited
disclaimers; 'audited-adjacent' overstated their status. Describe them neutrally
as integration examples / composition recipes.
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1e92533f-e15f-4b06-98d9-ce411e4b48a1

📥 Commits

Reviewing files that changed from the base of the PR and between 95dca41 and ff11a2f.

📒 Files selected for processing (1)
  • llms.txt

📝 Walkthrough

Walkthrough

A single line in llms.txt is updated, replacing the phrase "audited-adjacent" with "compilable integration examples (composition recipes)" in the bullet describing the examples/ directory under the "For each package" section.

Changes

llms.txt wording update

Layer / File(s) Summary
Update examples/ bullet description
llms.txt
Replaces "audited-adjacent" with "compilable integration examples (composition recipes)" in the examples/ directory description.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

A single word swapped, a small hoppy fix,
"audited-adjacent" lost in the mix.
Now "composition recipes" grace the page,
A clearer crumb left on the doc's stage.
🐇✨ One line changed, the warren is bright!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description clearly explains why the change was made but lacks required sections like 'Resolves #???' issue reference and PR Checklist items from the template. Add the issue reference (Resolves #???) and complete the PR Checklist section with checkboxes for Tests, Documentation, and Changelog as specified in the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: removing the 'audit-status claim' (audited-adjacent label) from the examples line in llms.txt.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/llms-examples-neutral

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.41%. Comparing base (95dca41) to head (ff11a2f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #407   +/-   ##
=======================================
  Coverage   82.41%   82.41%           
=======================================
  Files          26       26           
  Lines        2201     2201           
  Branches      713      707    -6     
=======================================
  Hits         1814     1814           
  Misses        350      350           
  Partials       37       37           
Flag Coverage Δ
contracts/access 65.46% <ø> (ø)
contracts/allowance 52.00% <ø> (ø)
contracts/finance 25.57% <ø> (ø)
contracts/utils 44.09% <ø> (ø)
math/fixed_point 56.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bidzyyys
bidzyyys merged commit 0f02f8e into main Jun 23, 2026
21 of 22 checks passed
@bidzyyys
bidzyyys deleted the docs/llms-examples-neutral branch June 23, 2026 20:57
@coderabbitai coderabbitai Bot mentioned this pull request Jul 9, 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.

[Feature]: Downstream discovery — MVR documentation_url + docs-site llms.txt

3 participants