Skip to content

docs: improve package READMEs with monorepo setup guidance#66

Merged
Emieldv merged 1 commit intomainfrom
docs/improve-package-readmes
Mar 28, 2026
Merged

docs: improve package READMEs with monorepo setup guidance#66
Emieldv merged 1 commit intomainfrom
docs/improve-package-readmes

Conversation

@Emieldv
Copy link
Copy Markdown
Contributor

@Emieldv Emieldv commented Mar 28, 2026

Summary

  • Adds Monorepo setup sections to both @nimblestudio/biome-config and @nimblestudio/tsconfig READMEs, explaining config resolution, root: false, recommended directory structure, and step-by-step setup
  • Adds Overriding rules and Config composition sections to biome-config README
  • Adds Multiple tsconfigs pattern (project references) and Config hierarchy tree to tsconfig README
  • Expands config table in tsconfig README with key settings per preset

Test plan

  • Verify README renders correctly on GitHub/npm
  • Confirm all code examples are accurate against current config files

Add monorepo configuration sections to both biome-config and tsconfig
READMEs, explaining config resolution, recommended structure, and
common patterns like project references and rule overrides.
@Emieldv Emieldv merged commit 3925d11 into main Mar 28, 2026
1 check passed
@Emieldv Emieldv deleted the docs/improve-package-readmes branch March 28, 2026 16:42
@github-actions github-actions bot mentioned this pull request Mar 28, 2026
@nimble-sidekick nimble-sidekick bot mentioned this pull request Apr 20, 2026
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