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

Documentation improvement suggestions #674

Closed
skurfuerst opened this issue Jun 20, 2023 · 6 comments · Fixed by #1365
Closed

Documentation improvement suggestions #674

skurfuerst opened this issue Jun 20, 2023 · 6 comments · Fixed by #1365
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@skurfuerst
Copy link

Describe the bug

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

  • an introduction to services in the main menu here next to "languages": https://devenv.sh/languages/
  • some a bit more in depth examples on "languages" how you can customize languages
  • some more complete examples for full applications.
  • Bonus: some example/explanation about extensibility

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.

@skurfuerst skurfuerst added the bug Something isn't working label Jun 20, 2023
@MatrixManAtYrService
Copy link

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
Copy link
Author

That would be useful :)

@skurfuerst
Copy link
Author

@domenkozar
Copy link
Member

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

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

@domenkozar
Copy link
Member

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.

@k3yss k3yss added the documentation Improvements or additions to documentation label Aug 8, 2024
@domenkozar
Copy link
Member

Finally done! Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
4 participants