What information should be "recommended" in each template's docs?

[jcbhmr]

There is no agreement on what information should be included in the document at this time, so there are only minimal notes. Ideally, we should put the names of the maintainers, as in https://github.com/microsoft/vscode-dev-containers.

— @eitsupi #2 (comment)

Here's some ideas of stuff that might be good to have:

• If it's transferred from somewhere else, include some kind of link, commit stamp, or archive.org or something to the original
• A list of usernames that a user can @mention to contact the maintainers/authors/relevant people
• What the template lets you do (what are the tools inside it?)

FUTURE IDEA Here's some other ideas that are more like "wrapper things" that would be good to have the same on all template docs. Sorta like a footer/header on a website: These ideas kinda need a static site generator to do. Don't worry about them now.

• Link to create a new issue about a bug/crash (more so for things like features, not templates)
• Link to ask a question/help in Discussions Q&A
• Link to suggest or add a new template

[jcbhmr]

Here's an example from https://github.com/devcontainers-community/features/tree/7efa43ce70e3ab498357830e9ba1a16df4f5c538/src/deno -- yes, it's a feature not a template, but I think it's a pretty good example of what I like in documentation: relevant information for users 😉

[eitsupi]

I think it is great to describe the general settings!.

We can also just add a comment in the jsonc (like devcontainers/templates#125 for example)

[jcbhmr]

Also as a reminder (this is more relevant for features) but when it crashes, the CLI will pop up saying something like:

Visit {documentationURL from devcontainer-*.json} for debugging help

So maybe it'd be good to have a sort of "need help? do this/create a Discussion" type thing in there too?