Skip to content

docs: reorganize and edit docs README #14706

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 5 commits into from
Oct 14, 2024
Merged

docs: reorganize and edit docs README #14706

merged 5 commits into from
Oct 14, 2024

Conversation

EdwardAngert
Copy link
Contributor

Edit the docs readme for consistency and better flow

@EdwardAngert EdwardAngert added the docs Area: coder.com/docs label Sep 17, 2024
@EdwardAngert EdwardAngert self-assigned this Sep 17, 2024
Copy link

github-actions bot commented Sep 17, 2024

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

LGTM, except a few comments. I don't need to review again.

@EdwardAngert
Copy link
Contributor Author

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
@stirby
Copy link
Collaborator

stirby commented Sep 18, 2024

In the coder/coder repo on your machine, run make fmt to satisfy CI.

@EdwardAngert
Copy link
Contributor Author

EdwardAngert commented Sep 18, 2024

thanks @stirby - I had a series of errors when I ran make fmt, even after installing all the dependencies and adding things to PATH (well, ~/.zprofile):

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 1

once I figured out it's just running prettier, I used npx instead and that seemed to do the trick: npx prettier -c docs/README.md (-c to check, then -w to write)

@matifali
Copy link
Member

matifali commented Sep 19, 2024

@EdwardAngert Edward You can also create a workspace from the dogfood template and run make fmt on your PR branch.
you can do it in 2 steps

  1. gh pr checkout 14706
  2. make fmt

@EdwardAngert EdwardAngert force-pushed the ea-rewrite-readme branch 5 times, most recently from 0f6085a to 66d75f8 Compare September 27, 2024 20:05
Base automatically changed from restructure-new to main October 5, 2024 15:52
@matifali
Copy link
Member

matifali commented Oct 5, 2024

I think it would be easy if you could redo this PR @EdwardAngert.

cc: @stirby

@EdwardAngert
Copy link
Contributor Author

@matifali rebasing seemed messy and complicated, so I reset the branch to match main and copied the changes over to the doc - I didn't rename it to index.md though, since the live version is still README.md (link). Should I rename it anyway and point manifest.json to it?

Co-authored-by: Muhammad Atif Ali <atif@coder.com>
@EdwardAngert EdwardAngert merged commit 88c6a75 into main Oct 14, 2024
24 checks passed
@EdwardAngert EdwardAngert deleted the ea-rewrite-readme branch October 14, 2024 17:39
@github-actions github-actions bot locked and limited conversation to collaborators Oct 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants