Skip to content

docs: reshape hero path into Getting Started funnel - #1254

Merged
gildesmarais merged 1 commit into
mainfrom
docs/hero-path-funnel
Sep 5, 2026
Merged

docs: reshape hero path into Getting Started funnel#1254
gildesmarais merged 1 commit into
mainfrom
docs/hero-path-funnel

Conversation

@gildesmarais

Copy link
Copy Markdown
Member

What changed

  • Canonical /getting-started/ is the 60s Docker auto-source quickstart; /web-application/getting-started/ redirects there and the duplicate page is removed.
  • Sidebar IA reshaped: Self-Hosting & Deployment, How It Works, AI Agent Workflows & MCP, Advanced Feeds (escape hatch), Ruby Gem & CLI.
  • New web-application/concepts.mdx (auto-source, Botasaurus, tokens, ecosystem map); deployment and creating-custom-feeds rewritten as funnel steps.
  • MCP docs use the 7 bare verbs; CLI docs cover apply/scrape; AI agent workflows cover the html2rss-config skill; Starlight Code component only.
  • Home/index and cross-links point along Getting Started → Deployment → Advanced Feeds; AGENTS.md funnel rules updated to match.

Why

Readers were forked across parallel “getting started” paths (web app vs root). One directed success path makes the Docker page-URL workflow primary and treats custom YAML as the escape hatch.

Risk

  • Low for content — docs-only.
  • Medium for bookmarks: old /web-application/getting-started/ relies on the Astro redirect; confirm it resolves in the built site.
  • Sidebar label/order changes may surprise returning contributors.

Review map

  1. src/content/docs/getting-started.mdx — canonical 60s quickstart
  2. astro.config.mjs — redirect + sidebar IA
  3. src/content/docs/web-application/concepts.mdx — new How It Works
  4. src/content/docs/ruby-gem/reference/mcp-server.mdx + cli-reference.mdx + guides/ai-agent-workflows.mdx — MCP/CLI/skill contracts
  5. src/content/docs/creating-custom-feeds.mdx + web-application/deployment.mdx — funnel step rewrites

Validation

  • not run: make check / make build (docs content commit; open requested without local build evidence)

Point readers through Docker auto-source quickstart → deployment →
advanced feeds; fold MCP/CLI/skill docs onto the same path and redirect
legacy /web-application/getting-started/.
@gildesmarais
gildesmarais marked this pull request as ready for review September 5, 2026 11:57
@gildesmarais
gildesmarais merged commit a683638 into main Sep 5, 2026
5 checks passed
@gildesmarais
gildesmarais deleted the docs/hero-path-funnel branch September 5, 2026 11:57
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