Skip to content

docs(readme): restructure README and move detailed content into docs - #19992

Draft
lakshay-nasa wants to merge 1 commit into
datahub-project:masterfrom
lakshay-nasa:docs/readme-restructure
Draft

lakshay-nasa wants to merge 1 commit into
datahub-project:masterfrom
lakshay-nasa:docs/readme-restructure

Conversation

@lakshay-nasa

@lakshay-nasa lakshay-nasa commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Restructures the root README into a shorter landing page and moves the detailed sections into the docs site, so nothing from the old README is lost.

README

  • New structure: overview, product tour, "Pick your path" (OSS vs Cloud), core capabilities, quick start, integrations, community, license
  • The product tour uses the existing GIF for now; an updated GIF will follow
  • Fixed the MCP quick start command. npx -y @acryldata/mcp-server-datahub init does not exist on npm; it now uses uvx mcp-server-datahub@latest, matching the MCP server docs
  • Consistent integration count (150+), a working license link, and a short requirements line for local quickstart (Docker 8GB RAM, Python 3.10+)
  • Docker pulls badge now points to acryldata/datahub-gms
  • Copyright notice kept

Where the old README content went

Old section New location
Company list and case studies ADOPTERS.md (new)
FAQ (datahub.io, datahubproject.io, LinkedIn origin, install, license) docs/faq.md (new)
Community channels, town halls, learning resources, important links docs/community.md (new)
Official repos, community plugins, integrations by category docs/ecosystem.md (new)
Product tour, screenshots, "Why DataHub", common use cases docs/features.md
Blog posts, talks, podcast, case studies docs/links.md
Architecture bullets docs/architecture/architecture.md
MCP example questions docs/features/feature-guides/mcp.md
Analytics Agent demo link docs/features/feature-guides/analytics-agent.md
Snowflake ingestion example (collapsible) metadata-ingestion/cli-ingestion.md
datahub.io clarification docs-website/static/llms.txt

Code examples that already have maintained versions in the docs (Python SDK search, GraphQL lineage, adding descriptions) are linked rather than duplicated.

Docs site

  • The root README is no longer built into the docs site; /docs/introduction redirects to /docs/features
  • FAQ added under "What Is DataHub?"; Community, Ecosystem, and Adopters added under "Community"
  • Fixed three links (source-docs-template.md and two Java SDK v2 pages) that only resolved via the root README

Testing

  • ./gradlew :datahub-web-react:mdPrettierCheck passes
  • ./gradlew :docs-website:yarnLint passes
  • ./gradlew :docs-website:yarnBuild passes; verified the new pages render and /docs/introduction redirects

Checklist

  • The PR conforms to DataHub's Contributing Guideline (PR Title Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated
  • Breaking change entry in Updating DataHub (not applicable)

Summary by cubic

Restructures the root README into a short landing page and moves the detailed documentation into the docs site so nothing is lost.

  • Adds new docs pages for adopters, FAQ, community, and ecosystem, and moves the product tour, "Why DataHub", use cases, architecture, MCP examples, and Snowflake ingestion examples into existing docs pages.
  • The README is no longer built into the docs site; /docs/introduction now redirects to /docs/features.
  • Fixes the MCP quickstart command to use uvx mcp-server-datahub@latest instead of the non-existent npx -y @acryldata/mcp-server-datahub init, and fixes three links that only resolved via the old README.

Written for commit 38625f8. Summary will update on new commits.

Review in cubic

Shorter README; detailed sections moved to new and existing docs pages. Fixes the MCP install command and redirects /docs/introduction to /docs/features.
@github-actions github-actions Bot added ingestion PR or Issue related to the ingestion of metadata docs Issues and Improvements to docs community-contribution PR or Issue raised by member(s) of DataHub Community labels Sep 25, 2026
@codecov

codecov Bot commented Sep 25, 2026

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

@codecov

codecov Bot commented Sep 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

This branch was successfully deployed

1 active deployment
Preview — 38625f83 Deployed Sep 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution PR or Issue raised by member(s) of DataHub Community docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant