Skip to content

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

Merged
merged 9 commits into from
Apr 2, 2025
Merged

Ghost writing the docs with robots #3951

merged 9 commits into from
Apr 2, 2025

Conversation

acolytec3
Copy link
Contributor

@acolytec3 acolytec3 commented Mar 31, 2025

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.

  1. Deletes both the e2e_testing and monorepo docs from config and consolidates and slims down the remaining two readmes.
  2. Remove references to verdaccio and replace with using npm link for local testing with external projects
  3. Updates some comments about linting

@acolytec3
Copy link
Contributor Author

Might fix #3946

Copy link

codecov bot commented Mar 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.64%. Comparing base (bea4425) to head (24952e9).
Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

Flag Coverage Δ
block 83.29% <ø> (ø)
blockchain 89.33% <ø> (ø)
client 68.09% <ø> (ø)
common 98.49% <ø> (ø)
devp2p 86.73% <ø> (+0.07%) ⬆️
evm 72.98% <ø> (ø)
genesis 99.98% <ø> (ø)
mpt 89.76% <ø> (-0.26%) ⬇️
rlp 91.43% <ø> (ø)
statemanager 69.16% <ø> (ø)
tx 90.58% <ø> (ø)
util 81.96% <ø> (ø)
vm 57.20% <ø> (ø)
wallet 88.55% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Run TypeScript scripts: `tsx --conditions=typescript myScript.ts`
- Set environment variable for bash scripts: `NODE_OPTIONS='--conditions=typescript'`

### Testing Packages with an external project
Copy link
Contributor

@scorbajio scorbajio Mar 31, 2025

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.

Copy link
Contributor Author

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

scorbajio
scorbajio previously approved these changes Apr 1, 2025
Copy link
Contributor

@scorbajio scorbajio left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@holgerd77 holgerd77 left a 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!

@holgerd77 holgerd77 marked this pull request as ready for review April 2, 2025 10:12
@holgerd77 holgerd77 merged commit 1481a27 into master Apr 2, 2025
40 of 41 checks passed
@holgerd77 holgerd77 deleted the robot-ghostwriter branch April 2, 2025 10:12
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.

4 participants