This repository has been archived by the owner on Aug 3, 2023. It is now read-only.
Move docs from READMEs to real docs #823
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
exvuma
force-pushed
the
victoria/docs-move
branch
from
d9d0396
to
6eb1a85
Compare
ashleymichal
suggested changes
Oct 30, 2019
There was a problem hiding this comment.
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.
ashleygwilliams
changed the title
retain (truncated) command descriptions, add getting started
exvuma
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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