redhat-et / redhat-et/docsclaw

web_search markdown output does not escape special characters

Open Beginner friendly
#105 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Go
Stars
2
Forks
1
Avg merge
6h 9m
Merged PRs (30d)
1

Description

Background

internal/websearch/websearch.go inserts search result titles, snippets, and URLs raw into Markdown links (* [Title](URL): Snippet). If any of these fields contain ], ), or ", the generated Markdown can be malformed.

Expected behavior

Special Markdown characters in titles/snippets/URLs should be escaped so the output renders correctly.

Files to change

  • internal/websearch/websearch.go
  • internal/websearch/websearch_test.go

Related

PR #102 (Phase 2 OpenClaw/Hermes tool compatibility)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in internal/websearch/websearch.go, where search result titles, snippets, and URLs are inserted into Markdown links. Review internal/websearch/websearch_test.go and add coverage for fields containing ], ), and ". Done means the generated Markdown escapes these characters and renders correctly without malformed links.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.