Skip to content

docs: overhaul README + landing page (toolkit + data engine)#33

Merged
arpitg1304 merged 1 commit into
mainfrom
docs/readme-and-landing
Jul 19, 2026
Merged

docs: overhaul README + landing page (toolkit + data engine)#33
arpitg1304 merged 1 commit into
mainfrom
docs/readme-and-landing

Conversation

@arpitg1304

Copy link
Copy Markdown
Owner

What

The README and the landing page (docs/index.html) had grown as a flat list of per-dataset features and predated the catalog work entirely. This reframes both around the two things Forge now is: a format toolkit and a data engine.

README (487 → 346 lines)

  • Three-part structure: # The format toolkit (grouped into Convert & interop · Score & clean · Understand) → # The data engine (a numbered pipeline ingest → query → embed → search → dedup → curate → Studio) → # Reference.
  • Nav table with jump-links at the top; a one-line "Forge is two things that share one core" framing.
  • Install leads with pip install forge-robotics + a compact extras table, and an honest note that the data-engine features (catalog, search, Studio) are newer than the last PyPI tag → install from source for now.
  • Collapsible <details> for depth (the 8 quality metrics, RoboDM); merged the redundant Quick Start / Usage / CLI Reference sections into a 60-second taste + a command cheatsheet. All 19 internal links verified.

Landing page (docs/index.html, +139 lines)

  • New "The Data Engine" section — catalog, semantic search, dedup & curation, Forge Studio, cloud-native, and idempotent/versioned — using the page's existing card design system, plus an ingest → … → Studio flow strip.
  • Hero tagline, <title>/meta description, and nav reframed to cover both halves; the Features section relabeled "The Toolkit"; a 4th "Build a corpus" quickstart step.
  • New .engine-flow CSS added in-system; tag balance + section order validated.

No code changes — docs only.

🤖 Generated with Claude Code

…+ data engine)

The README and landing page had grown as a flat list of per-dataset features and
predated the catalog work. Restructure both around the two things Forge now is:
a format toolkit and a data engine.

README (487 -> 346 lines):
- Three parts: "The format toolkit" (grouped Convert & interop / Score & clean /
  Understand), "The data engine" (numbered pipeline ingest -> query -> embed ->
  search -> dedup -> curate -> Studio), and "Reference".
- Nav table with jump-links; install leads with `pip install forge-robotics` +
  an extras table and a note that the data-engine features are newer than the
  last PyPI tag (install from source for now).
- Collapsible <details> for depth (quality metrics, RoboDM); merged the
  redundant Quick Start / Usage / CLI-reference sections into a 60s taste + a
  command cheatsheet. All internal links verified.

Landing page (docs/index.html):
- New "The Data Engine" section (catalog, semantic search, dedup & curation,
  Forge Studio, cloud-native, idempotent/versioned) using the existing card
  design system, plus an ingest->...->Studio flow strip.
- Hero tagline, <title>/meta, and nav reframed to cover both halves; Features
  section relabeled as "The Toolkit"; a 4th "Build a corpus" quickstart step.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@arpitg1304
arpitg1304 merged commit 21099e9 into main Jul 19, 2026
3 checks passed
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