Skip to content

Commit

Permalink
Add tutorial to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Aug 13, 2024
1 parent 6517f11 commit eab490c
Show file tree
Hide file tree
Showing 7 changed files with 1,002 additions and 21 deletions.
10 changes: 8 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,20 @@

```{toctree}
:caption: Basics
:maxdepth: 2
:maxdepth: 3
:hidden:
self
getting-started
installation
tutorials/beginner-tutorial
```

```{toctree}
:caption: Tutorials
:maxdepth: 3
:hidden:
tutorials/intro
```

```{toctree}
Expand Down
15 changes: 15 additions & 0 deletions docs/source/tutorials/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 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. You will also be able to search dynamically for saved Meals.

```{toctree}
mealplan/django-app
mealplan/unicorn-functionality
mealplan/unicorn-advanced
mealplan/summary
mealplan/full-text-tutorial.md
```
Loading

0 comments on commit eab490c

Please sign in to comment.