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

[Feature Request] Changes in the documentation #541

Open
mdziczkowski opened this issue Jan 21, 2025 · 0 comments
Open

[Feature Request] Changes in the documentation #541

mdziczkowski opened this issue Jan 21, 2025 · 0 comments

Comments

@mdziczkowski
Copy link

Request

Please do following changes in the documentation:

  1. separate the references from the remaining documentation. It should have own group

  2. add separate section with examples of each file, in with each would be:

  • all existing in specification options
  • for each option would be all possible values
  • for options with multiple values, include the separator
  • for each file to with it apply, put examples for both: local and remote references (for example in: devcontainer.json , features, templates, Dockerfile, etc.)
  1. Group the documentation by (for example): topic category, etc. instead of leaving it mixed up

  2. add navigation and search, with would allow to easier find required informations

Explanation

Above proposals would make easier to create devcontainers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant