cachix / devenv

Fast, Declarative, Reproducible, and Composable Developer Environments
https://devenv.sh
Apache License 2.0
3.97k stars 296 forks source link

Documentation improvement suggestions #674

Closed skurfuerst closed 1 week ago

skurfuerst commented 1 year ago

Describe the bug

The docs which existed were totally understandable etc; but I missed the following things:

Generally, I first thought that devenv.sh can maybe do 20% of what it can really do from first skimming the docs; only when I discovered https://devenv.sh/reference/options/, I saw how powerful it really is.

MatrixManAtYrService commented 1 year ago

I wonder if there's a way to compile a list of projects using devenv. Exploring their configurations would be very helpful, and perhaps less work than creating examples.

skurfuerst commented 1 year ago

That would be useful :)

skurfuerst commented 1 year ago

I know about https://github.com/kellerkinderDE/devenv-shopware and

https://github.com/sandstorm/devenv-neos (my own).

All the best!

domenkozar commented 1 year ago

I've pushed ce36bb6cebedfdfd19e4043836d51bde8b3c1419 that adds services and improve docs on languages.

We still need to write a guide how to customize devenv and provide more examples.

domenkozar commented 5 months ago

cc @k3yss: ideally we'd have something like languages.python.doc that would describe how the language bits are used and then we'd render that in the manual.

domenkozar commented 1 week ago

Finally done! Thank you.