Skip to content

docs: expand README sections and update API base URL#19

Merged
VinciGit00 merged 2 commits intomainfrom
docs/expand-readme-and-update-api-url
Apr 27, 2026
Merged

docs: expand README sections and update API base URL#19
VinciGit00 merged 2 commits intomainfrom
docs/expand-readme-and-update-api-url

Conversation

@VinciGit00
Copy link
Copy Markdown
Member

@VinciGit00 VinciGit00 commented Apr 27, 2026

Summary

  • Replace the bare docs link under each command heading (Scrape, Extract, Search, Crawl, Monitor, History) with a one-line description and a few example invocations, mirroring the docs introduction page surface.
  • Add short blurbs to the Credits and Validate sections.
  • Update the documented SGAI_API_URL default to https://v2-api.scrapegraphai.com in both README.md and skills/just-scrape/SKILL.md (the previous https://api.scrapegraphai.com/api/v2 is outdated).

Test plan

  • Render README.md on GitHub and confirm each command section shows the new description + examples.
  • Confirm SGAI_API_URL table row in both files reads https://v2-api.scrapegraphai.com.

🤖 Generated with Claude Code

VinciGit00 and others added 2 commits April 27, 2026 13:14
Flesh out per-command sections (Scrape, Extract, Search, Crawl, Monitor,
History) with short descriptions and example invocations instead of
bare docs links. Update the documented SGAI_API_URL default in README
and SKILL.md to https://v2-api.scrapegraphai.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The docs.scrapegraphai.com/api-reference/{scrape,extract,search,crawl,
monitor,history} URLs do not exist. Drop them from each command
section in the README.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@VinciGit00 VinciGit00 merged commit 383c1bd into main Apr 27, 2026
2 checks passed
@VinciGit00 VinciGit00 deleted the docs/expand-readme-and-update-api-url branch April 27, 2026 11:38
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.

1 participant