[SDK-JS] Add per-package READMEs and a getting-started root README#190
Draft
parthban-db wants to merge 1 commit into
Draft
[SDK-JS] Add per-package READMEs and a getting-started root README#190parthban-db wants to merge 1 commit into
parthban-db wants to merge 1 commit into
Conversation
|
Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. |
Regenerates the SDK to add a README.md to every generated package and replaces the preview-warning-only root README with a real getting-started guide covering install, authentication, and a first API call. Generated packages shipped with no README, so each @databricks/sdk-* npm page was blank with no install command or usage snippet, and the root README only carried a preview warning, leaving no getting-started path. This blocks the DAIS launch. The per-package READMEs are uniform and emitted by the generator; the root README is a one-off and stays hand-written. Each generated package now contains a README.md with the npm name as title, the package description, an Installation section, and a Usage snippet importing the package's Client, with a link back to the root README. The root README documents requirements, install, the three auth flows (PAT, U2M, M2M), a first JobsClient call, and pointers to per-package and options docs, retaining the preview warning. The per-package READMEs are generated output. This regen pairs with the universe generator PR that adds the README renderer and must land together so the generated READMEs match the generator. npm run build, npm test --workspace @databricks/sdk-core, the @databricks/sdk-examples suite, npm run lint, and npm run typecheck all pass. Only README.md files changed; pre-existing regen drift was discarded to keep the PR fix-only. Co-authored-by: Isaac
parthban-db
force-pushed
the
parthban-db/stack/bugbash-bug10-readmes
branch
from
427eec5 to
29dff3f
Compare
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
1 participant
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.
🥞 Stacked PR
Use this link to review incremental changes.
Summary
Adds a
README.mdto every generated package and replaces the preview-warning-only root README with a getting-started guide, so each@databricks/sdk-*npm page and the repo root have install and usage docs.Why
Generated packages shipped without a README, leaving each npm package page blank with no install command or usage snippet, and the root README carried only a preview warning with no getting-started path. This adds the missing documentation ahead of the DAIS launch.
What changed
README.mdacross all generated packages: npm title, install command, aUsagesnippet importing the package's client, and a link back to the root README.JobsClientcall, and pointers to per-package and@databricks/sdk-optionsdocs, retaining the preview warning.Validated:
npm run build,npm test,npm run lint, andnpm run typecheckall pass.