Skip to content

docs: improve README discoverability for search - #80

Merged
pauliusminialga-dc merged 4 commits into
mainfrom
docs/readme-discoverability
Nov 3, 2026
Merged

pauliusminialga-dc merged 4 commits into
mainfrom
docs/readme-discoverability

Conversation

@pauliusminialga-dc

Copy link
Copy Markdown
Contributor

Why

github.com/Decodo/pobear is not in Google's index. site:github.com/Decodo/pobear returns zero results, and even searching the repo's exact description phrase returns nothing. The only indexed page that mentions pobear is github.com/orgs/Decodo/repositories.

The README body is the part of the repo page search engines read for topical signals, so this PR adds the vocabulary developers actually search for and answers the decision-stage questions on the page itself.

Changes

  • Intro. Name the command line, the terminal, and the Go binary, plus the runtimes pobear does not require. "Go" previously appeared only under Development.
  • Documentation nav line above Quick start, linking the three docs/ references. The help.decodo.com page slots in first here once it ships.
  • Three new FAQ entries. FAQ headings render as h3 and map directly onto real queries:
    • How do I scrape a website from the terminal?
    • Do I need Go installed to run pobear?
    • How is pobear different from the Decodo CLI?

The last one also separates pobear from Decodo/cli, which targets the same "web scraping CLI" queries from the opposite default: every Decodo CLI request goes through the API, while pobear fetches directly and escalates only when blocked.

No wording outside these additions was changed.

Not in this PR

The repo's title tag and meta description are built from the repo description field, not the README H1:

<title>GitHub - Decodo/pobear: Sniff out your data with any tool you want · GitHub</title>

Updating the description, topics (currently 3, vs 14 on Decodo/cli), and homepage is the larger lever and needs a repo settings change rather than a commit.

Test plan

  • README renders correctly on the branch page
  • Anchor links #quick-start and #development resolve
  • Platform claim matches release assets (v0.3.4 ships darwin, linux, and windows on amd64 and arm64)

The repo page is absent from Google's index, and the README body is the
only part of it search engines read for topical signals. Add the
vocabulary developers actually search for and answer the decision-stage
questions on the page itself.

- Name the command line, terminal, and Go binary in the intro, alongside
  the runtimes pobear does not require.
- Add a documentation nav line above Quick start.
- Add three FAQ entries: scraping from the terminal, the Go runtime
  question, and how pobear differs from the Decodo CLI.

The FAQ comparison also separates pobear from Decodo/cli, which targets
the same "web scraping CLI" queries from the opposite default.
Updated instructions for using the Decodo provider with pobear to include rendering option.
Updated README to include a hyperlink for pobear.
The repo description now carries the search keywords, so the original
line moves into the README, where it reads as a tagline rather than as
the only thing Google knows about pobear.
@pauliusminialga-dc
pauliusminialga-dc merged commit b01361e into main Nov 3, 2026
5 checks passed
@pauliusminialga-dc
pauliusminialga-dc deleted the docs/readme-discoverability branch November 3, 2026 08:05
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.

3 participants