-
Notifications
You must be signed in to change notification settings - Fork 802
Ghost writing the docs with robots #3951
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
Conversation
Might fix #3946 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
- Run TypeScript scripts: `tsx --conditions=typescript myScript.ts` | ||
- Set environment variable for bash scripts: `NODE_OPTIONS='--conditions=typescript'` | ||
|
||
### Testing Packages with an external project |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section explains how to selectively build only a linked package instead of the full project? What are the benefits of using npm link
here instead of building and running tests. We might want to add that context if we want to keep the section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is for when you want to test a dependency with an external project. It's probably a relatively rare scenario in our case but if for example you are building some sort of a library that wraps @ethereumjs/tx
and you want to implement support for the new TXCREATE
opcode for EOF that adds a new transaction type and then consume that new transaction type in your downstream library, you can do npm link @ethereumjs/tx
in your library after doing npm link
from the ethereumjs-monorepo/packages/tx
directory and npm will symlink the tx
package dependency in your downstream library to point to the local version you've edited (so you don't have to publish a fork on npm and change to that in your package.json
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
… outdated detailed-doc section with new config guide link, also redunda nt getting-started section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have done some additional updates, looks good now! 🙂
Will continue to focus on the docs in the upcoming days and weeks!
This is an experiment where I had robots write the first and second drafts of a general docs rewrite. I've done some extensive editing as well since I wasn't super pleased with the first draft but this looks ok. Lemme know thoughts and we can keep along this or just do it the old fashioned way.
The basic idea is get rid of outdated content (all the verdaccio references), and consolidate some basic stuff.
monorepo
docs fromconfig
and consolidates and slims down the remaining two readmes.npm link
for local testing with external projects