docs(readme): restructure README and move detailed content into docs - #19992
Draft
lakshay-nasa wants to merge 1 commit into
Draft
lakshay-nasa wants to merge 1 commit into
lakshay-nasa wants to merge 1 commit into
Conversation
Shorter README; detailed sections moved to new and existing docs pages. Fixes the MCP install command and redirects /docs/introduction to /docs/features.
Bundle ReportBundle size has no change ✅ |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
npx -y @acryldata/mcp-server-datahub initdoes not exist on npm; it now usesuvx mcp-server-datahub@latest, matching the MCP server docsacryldata/datahub-gmsWhere the old README content went
ADOPTERS.md(new)docs/faq.md(new)docs/community.md(new)docs/ecosystem.md(new)docs/features.mddocs/links.mddocs/architecture/architecture.mddocs/features/feature-guides/mcp.mddocs/features/feature-guides/analytics-agent.mdmetadata-ingestion/cli-ingestion.mddocs-website/static/llms.txtCode examples that already have maintained versions in the docs (Python SDK search, GraphQL lineage, adding descriptions) are linked rather than duplicated.
Docs site
/docs/introductionredirects to/docs/featuressource-docs-template.mdand two Java SDK v2 pages) that only resolved via the root READMETesting
./gradlew :datahub-web-react:mdPrettierCheckpasses./gradlew :docs-website:yarnLintpasses./gradlew :docs-website:yarnBuildpasses; verified the new pages render and/docs/introductionredirectsChecklist
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.
/docs/introductionnow redirects to/docs/features.uvx mcp-server-datahub@latestinstead of the non-existentnpx -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.