Skip to content

Fix incorrect rendering of brave costs in docs#44989

Merged
altaywtf merged 2 commits intoopenclaw:mainfrom
keelanfh:fix/incorrect-rendering-brave-costs
Mar 13, 2026
Merged

Fix incorrect rendering of brave costs in docs#44989
altaywtf merged 2 commits intoopenclaw:mainfrom
keelanfh:fix/incorrect-rendering-brave-costs

Conversation

@keelanfh
Copy link
Contributor

Summary

Describe the problem and fix in 2–5 bullets:

  • Problem: Cost information for Brave Search is rendered incorrectly due to unescaped $
  • Why it matters: Inconvenient when reading the docs
  • What changed: 3 docs markdown files changed.
  • What did NOT change (scope boundary):

Change Type (select all)

  • Bug fix
  • Feature
  • Refactor
  • Docs
  • Security hardening
  • Chore/infra

Scope (select all touched areas)

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

User-visible / Behavior Changes

image

became

image

Security Impact (required)

  • New permissions/capabilities? (No)
  • Secrets/tokens handling changed? (No)
  • New/changed network calls? (No)
  • Command/tool execution surface changed? (No)
  • Data access scope changed? (No)
  • If any Yes, explain risk + mitigation:

Repro + Verification

Environment

  • OS: macOS
  • Runtime/container:
  • Model/provider:
  • Integration/channel (if any):
  • Relevant config (redacted):

Steps

Expected

Actual

Evidence

Attach at least one:

  • Failing test/log before + passing after
  • Trace/log snippets
  • Screenshot/recording
image

became

image
  • Perf numbers (if relevant)

Human Verification (required)

What you personally verified (not just CI), and how:

  • Verified scenarios: I built the docs and checked that these three sections now rendered correctly.
  • Edge cases checked:
  • What you did not verify:

Review Conversations

  • I replied to or resolved every bot review conversation I addressed in this PR.
  • I left unresolved only the conversations that still need reviewer or maintainer judgment.

If a bot review conversation is addressed by this PR, resolve that conversation yourself. Do not leave bot review conversation cleanup for maintainers.

Compatibility / Migration

  • Backward compatible? (Yes/No)
  • Config/env changes? (Yes/No)
  • Migration needed? (Yes/No)
  • If yes, exact upgrade steps:

Failure Recovery (if this breaks)

  • How to disable/revert this change quickly:
  • Files/config to restore:
  • Known bad symptoms reviewers should watch for:

Risks and Mitigations

List only real risks for this PR. Add/remove entries as needed. If none, write None.

  • Risk:
    • Mitigation:

@openclaw-barnacle openclaw-barnacle bot added docs Improvements or additions to documentation size: XS labels Mar 13, 2026
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 13, 2026

Greptile Summary

This PR fixes a docs rendering issue where unescaped $ characters in three Brave Search cost description paragraphs were being incorrectly interpreted by the MDX/markdown renderer, causing the dollar amounts to display as garbled or missing text. The fix consistently escapes all six affected $ signs across docs/brave-search.md, docs/reference/api-usage-costs.md, and docs/tools/web.md.

  • All six $ occurrences across the three files are correctly escaped to \$.
  • No logic, configuration, or behavior changes — purely a documentation fix.
  • The author verified the fix by building the docs locally.

Confidence Score: 5/5

  • This PR is safe to merge — it is a minimal, self-contained docs-only fix with no code or behavior changes.
  • All changes are cosmetic escaping of $ in markdown files. There is no risk of regressions, and the author confirmed correctness by building the docs locally.
  • No files require special attention.

Last reviewed commit: 8a38b27

@altaywtf altaywtf self-assigned this Mar 13, 2026
@altaywtf altaywtf force-pushed the fix/incorrect-rendering-brave-costs branch 4 times, most recently from 2a6886e to b79b375 Compare March 13, 2026 18:36
@altaywtf altaywtf force-pushed the fix/incorrect-rendering-brave-costs branch from b79b375 to 8c69de8 Compare March 13, 2026 18:37
@altaywtf altaywtf merged commit fc408bb into openclaw:main Mar 13, 2026
21 checks passed
@altaywtf
Copy link
Member

Merged via squash.

Thanks @keelanfh!

z-hao-wang pushed a commit to z-hao-wang/openclaw that referenced this pull request Mar 13, 2026
Merged via squash.

Prepared head SHA: 8c69de8
Co-authored-by: keelanfh <[email protected]>
Co-authored-by: altaywtf <[email protected]>
Reviewed-by: @altaywtf
frankekn pushed a commit to xinhuagu/openclaw that referenced this pull request Mar 14, 2026
Merged via squash.

Prepared head SHA: 8c69de8
Co-authored-by: keelanfh <[email protected]>
Co-authored-by: altaywtf <[email protected]>
Reviewed-by: @altaywtf
ecochran76 pushed a commit to ecochran76/openclaw that referenced this pull request Mar 14, 2026
Merged via squash.

Prepared head SHA: 8c69de8
Co-authored-by: keelanfh <[email protected]>
Co-authored-by: altaywtf <[email protected]>
Reviewed-by: @altaywtf
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Cost information for Brave Search is rendered incorrectly in docs

2 participants