Skip to content

#699 improve tutorial #726

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,22 @@
self
getting-started
installation
components
```

```{toctree}
:caption: Components
:caption: Tutorials
:maxdepth: 3
:hidden:

tutorials/intro
```

```{toctree}
:caption: Overview
:maxdepth: 3
:hidden:

components
views
templates
actions
Expand Down
17 changes: 17 additions & 0 deletions docs/source/tutorials/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Meal Plan Tutorial

```{note}
This tutorial is intended to familiarize you with some basic concepts around Django Unicorn. If you have little to no prior experience with Django or other web frameworks, this is a good place to start. However, having basic knowledge of Python and web development concepts will prove helpful.
```

The goal of this tutorial is to develop a Meal Plan application. With Django Unicorn, you will be able to create "Meals" and add them without refreshing the page. This will include basic form validation, as well as a way to clear your list automatically.

Let's dive in!

```{toctree}
mealplan/django-app
mealplan/unicorn-functionality
mealplan/unicorn-advanced
mealplan/finished-app
mealplan/summary
```
Loading
Loading