Skip to content
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

Add developer setup docs, move some README contents there #1265

Open
rmunn opened this issue Nov 22, 2024 · 0 comments · May be fixed by #1305
Open

Add developer setup docs, move some README contents there #1265

rmunn opened this issue Nov 22, 2024 · 0 comments · May be fixed by #1305
Assignees
Labels
documentation Improvements or additions to documentation 🧑‍💻 DX Developer experience problem

Comments

@rmunn
Copy link
Contributor

rmunn commented Nov 22, 2024

We could trim down the README by moving developer setup instructions to a different document. That way the tips like "on Windows, you need to do this to allow Powershell scripts to run" or "on Linux, do this to prevent docker-desktop from filling up /var/log/syslog" could live in different files and the README could be shorter.

I suggest creating DEVELOPER-win.md, DEVELOPER-osx.md, and DEVELOPER-linux.md and linking them from the main README, then moving several of the OS-specific README sections into those files.

@rmunn rmunn added the task no code task label Nov 22, 2024
@rmunn rmunn added documentation Improvements or additions to documentation 🧑‍💻 DX Developer experience problem and removed task no code task labels Nov 22, 2024
@rmunn rmunn self-assigned this Dec 6, 2024
@rmunn rmunn linked a pull request Dec 6, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🧑‍💻 DX Developer experience problem
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant