docs: reorganize and edit docs README #14706
Merged
Conversation
This file contains hidden or 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
8000
|
All contributors have signed the CLA ✍️ ✅ |
matifali
approved these changes
Sep 18, 2024
|
I have read the CLA Document and I hereby sign the CLA |
cdrcommunity
added a commit
to coder/cla
that referenced
this pull request
Sep 18, 2024
EdwardAngert
commented
Sep 18, 2024
|
In the coder/coder repo on your machine, run |
|
thanks @stirby - I had a series of errors when I ran full error text❯ make fmt ─╯
ERROR: You need GNU getopt to run the scripts in the Coder repo.
On darwin:
- brew install gnu-getopt
- Add "$(brew --prefix gnu-getopt)/bin" to your PATH
- Restart your terminal
ERROR: You need at least make 4.0 to run the scripts in the Coder repo.
On darwin:
- brew install make
- Add "$(brew --prefix make)/libexec/gnubin" to your PATH
- Restart your terminal
ERROR: Invalid dependencies, see above for more details.
==> fmt/ts
ERR_PNPM_NO_SCRIPT Missing script: check:fix
Command "check:fix" not found.
make: *** [fmt/ts] Error 1once I figured out it's just running prettier, I used npx instead and that seemed to do the trick: |
|
@EdwardAngert Edward You can also create a workspace from the dogfood template and run
|
0f6085a to
66d75f8
Compare
matifali
reviewed
Sep 27, 2024
|
I think it would be easy if you could redo this PR @EdwardAngert. cc: @stirby |
27d23c3 to
3469242
Compare
EdwardAngert
commented
Oct 7, 2024
EdwardAngert
commented
Oct 7, 2024
EdwardAngert
commented
Oct 7, 2024
matifali
reviewed
Oct 8, 2024
matifali
reviewed
Oct 10, 2024
8000
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.
Edit the docs readme for consistency and better flow