-
Notifications
You must be signed in to change notification settings - Fork 337
Conversation
d9d0396
to
6eb1a85
Compare
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.
perhaps this has been discussed elsewhere, but there are specific pieces of information i think should always be included in a README and that I therefore think we should leave here:
- installation instructions - the happy path for both npm and cargo installations, with links to more complicated installation instructions
- a single "get started" that shows the base case to get someone running, something like install,
wrangler generate
, update toml,wrangler config
,wrangler publish
- basic commands and their usage (this one i have wiggle room on)
these things should be maintained, and copied to the npm readme. I think providing these will reduce the risk of dropoff from folks who discover wrangler via github. that all being said, reducing the wrangler readme to these elements will probably be super beneficial in terms of organization and signal/noise management in the repo.
I am happy to make a PR to this PR with my suggestions.
retain (truncated) command descriptions, add getting started
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 lovely
This PR removes all the unneeded docs code, fixes links to this github docs, and refines the README to simply point to developers.cloudflare.com/workers.
For nits please use suggestion in a comment 😸
Merge OK once cloudflare/workers-docs#485 is merged in