Document project template creation and usage to improve the developer experience

[thibaudcolas]

Pertinent section of the Wagtail docs

Project template or Management commands

Details

It’s really hard to find information about how to author and use project templates, for use with wagtail start. Here are specific improvements we should consider.

Template usage

• There should probably be a dedicated section of a page for the wagtail start command, separately from what we have for the default project template
• There should be docs search results for wagtail start, wagtail CLI, start template or equivalent search terms
• We should list available project templates compatible with the wagtail start command, and possibly existing resources (like Awesome Wagtail) with other project scaffolding approaches.

Template authoring

• Link to Django docs about startproject
• Provide information about the need to escape template syntax / use of the verbatim tag

Examples

• https://github.com/thibaudcolas/wagtail-tutorial-template
• https://github.com/torchbox/wagtail-news-template

Working on this

Anyone can contribute to this. This requires digging into how wagtail start works, and reviewing existing project templates. View our contributing guidelines, add a comment to the issue once you’re ready to start.

---

Any ideas on other ways to improve the template creation / usage experience very welcome.

[activus-d]

@thibaudcolas I would like to work on this.