devbox icon indicating copy to clipboard operation
devbox copied to clipboard

Add section about services to README.md file

Open ametad opened this issue 6 months ago • 0 comments

What problem are you trying to solve?

The README.md file is perfect to get an overview what to expect of the environment you can work with. There is a short installation guide of Devbox and how to invoke scripts. What scripts there are and what env vars there are. Even which packages are at your disposal.

But I miss a section about services:

  • which services there are;
  • how to start/stop them;
  • this documentation also ensures the reader knows about the existence of services;

What solution would you like?

A block in the documentation about services:

  • which services there are;
  • how to start/stop them;

About the same as how scripts are documented.

Alternatives you've considered

As an alternative I've used a script that does something like devbox services up. But I think that services is as important as scripts, packages, envs and therefore it should have it's own section in the README.md on generation.

ametad avatar Jun 04 '25 10:06 ametad