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.

Sign up for GitHub

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

Jump to bottom

Monorepo examples rewrite #3234

Closed
15 tasks done
acolytec3 opened this issue Jan 16, 2024 · 0 comments
Closed
15 tasks done

Monorepo examples rewrite #3234

acolytec3 opened this issue Jan 16, 2024 · 0 comments
Labels
package: monorepo type: docs type: meta type: refactor

Comments

@acolytec3
Copy link
Contributor

acolytec3 commented Jan 16, 2024 •
edited
Loading

The work of rewriting our code examples in the various READMEs as actual scripts that are accurate that then get embedded into the readmes using embedme was begun with #3226 and #3228 but should be finished up. Below is the list of what's been done and what's left to be finished.

For each package, we need to add a new script to package.json for "examples:build": "npx embedme README.md", and then update all the code blocks in the main README.md for that package to use embedme. Reference previous PRs for ways that we've modified/updated examples to reflect actual usage.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
package: monorepo type: docs type: meta type: refactor
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@holgerd77 @acolytec3