Skip to content

docs: add Baidu Search connector setup guide#1316

Merged
MODSetter merged 1 commit intoMODSetter:devfrom
jimmyzhuu:codex/add-baidu-search-docs-dev
Apr 28, 2026
Merged

docs: add Baidu Search connector setup guide#1316
MODSetter merged 1 commit intoMODSetter:devfrom
jimmyzhuu:codex/add-baidu-search-docs-dev

Conversation

@jimmyzhuu
Copy link
Copy Markdown
Contributor

@jimmyzhuu jimmyzhuu commented Apr 28, 2026

Description

This PR re-raises the Baidu Search connector documentation changes against the dev branch, as requested in #1305.

It adds documentation for the Baidu Search connector and updates related documentation surfaces so users can discover and configure it correctly.

Baidu Search is already supported as a live search connector in SurfSense. This change documents how to get a Baidu AI Search / Qianfan AppBuilder API key, how the connector behaves, and how to troubleshoot common setup issues.

Changes

  • Added a new Baidu Search connector guide:
    • surfsense_web/content/docs/connectors/baidu-search.mdx
  • Added Baidu Search to the connectors documentation navigation:
    • surfsense_web/content/docs/connectors/meta.json
  • Added a Baidu Search card to the connectors index page:
    • surfsense_web/content/docs/connectors/index.mdx
  • Updated the Web Search guide to explain optional live search connectors:
    • SearXNG remains the bundled default search engine
    • Baidu Search, Tavily, and Linkup can be configured per search space
  • Updated README external source lists to include Baidu Search alongside SearXNG, Tavily, and LinkUp.

Baidu API Reference

The new guide links to the Baidu AI Search product page and the API documentation that matches SurfSense's current backend integration:

Why This Matters

Before this change, Baidu Search was available in the product but missing from the connector documentation. Users could see the connector in the UI, but there was no dedicated setup guide explaining:

  • where to get the required API key
  • how Baidu Search differs from indexed connectors
  • when to use it for Chinese web search
  • how to troubleshoot authentication, timeout, and relevance issues

Validation

  • Ran git diff --check
  • Verified the new connector page is included in connectors/meta.json
  • Verified the connectors index links to /docs/connectors/baidu-search

I did not run the frontend build because surfsense_web/node_modules is not installed in this checkout.

High-level PR Summary

This PR adds comprehensive documentation for the Baidu Search connector, which is an existing feature in SurfSense that previously lacked setup documentation. The changes include a detailed connector setup guide explaining how to obtain and configure a Baidu Qianfan AppBuilder API key, when to use Baidu Search for Chinese web queries, and how to troubleshoot common issues. The connector is added to the documentation navigation and connectors index page, and README files across multiple languages are updated to list Baidu Search alongside other supported search engines. The Web Search guide is also updated to explain how optional live search connectors work in parallel with the bundled SearXNG engine.

⏱️ Estimated Review Time: 15-30 minutes

💡 Review Order Suggestion
Order File Path
1 surfsense_web/content/docs/connectors/baidu-search.mdx
2 surfsense_web/content/docs/connectors/meta.json
3 surfsense_web/content/docs/connectors/index.mdx
4 surfsense_web/content/docs/how-to/web-search.mdx
5 README.md
6 README.zh-CN.md
7 README.es.md
8 README.pt-BR.md
9 README.hi.md

Need help? Join our Discord

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

@jimmyzhuu is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f8237de7-6c49-4f91-95b5-36b82c910e45

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@MODSetter MODSetter merged commit 46544f9 into MODSetter:dev Apr 28, 2026
1 of 3 checks passed
@jimmyzhuu jimmyzhuu deleted the codex/add-baidu-search-docs-dev branch April 28, 2026 11:42
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