Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up and standardize READMEs #185

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

clean up and standardize READMEs #185

wants to merge 1 commit into from

Conversation

philmillman
Copy link
Contributor

there's a good amount of duplication happening here particularly in the code samples pulled from the docs. We may want to look into automating some of this README generation in the future if it becomes too much of a maintenance burden

Copy link

changeset-bot bot commented Dec 18, 2024

⚠️ No Changeset found

Latest commit: 642a529

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the maintainer Created by an official project maintainer label Dec 18, 2024
Copy link

Deploying dmno with  Cloudflare Pages  Cloudflare Pages

Latest commit: 642a529
Status: ✅  Deploy successful!
Preview URL: https://b07af3d1.dmno.pages.dev
Branch Preview URL: https://readme-cleanup.dmno.pages.dev

View logs

@@ -29,6 +26,7 @@ All commands are run from the root of the project, from a terminal:
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm run astro -- --help` | Get help using the Astro CLI |
| `cd ../../ && pnpm build:libs` | Run at root to build the libraries for the docs site |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can also do pnpm run -w build:libs (runs at the workspace level)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `cd ../../ && pnpm build:libs` | Run at root to build the libraries for the docs site |
| `pnpm run -w build:libs` | Run at root to build the libraries for the docs site |

@theoephraim
Copy link
Member

ooo i like these labels - lets wire up the changesets stuff to do it automatically :)

@philmillman
Copy link
Contributor Author

ooo i like these labels - lets wire up the changesets stuff to do it automatically :)

Sounds good, I'll see what I can do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants