Skip to content

Minor docs styling, formatting, and grammar improvements #76

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

Merged
merged 16 commits into from
Jun 6, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
bold "Django Project"
  • Loading branch information
Archmonger committed Jun 4, 2022
commit 19ec4dbeb87dcb8b17e1b907f549121b7c3fad07
4 changes: 2 additions & 2 deletions docs/getting-started/initial-steps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
???+ summary

Set up a Django Project with at least one app.
Set up a **Django Project** with at least one app.

---

Expand All @@ -10,7 +10,7 @@ For the examples within this section, we will assume you've placed the files [ge

??? question "How do I organize my Django project for IDOM?"

Django-IDOM has no project structure requirements. Organize everything as you wish, just like any Django project.
Django-IDOM has no project structure requirements. Organize everything as you wish, just like any **Django project**.

??? question "I've never used Django, what do I need to learn?"

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/render-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Now, navigate to `http://127.0.0.1:8000/example/`. If you copy-pasted the compon

??? question "Which urls.py do I add my views to?"

For simple Django projects, you can easily add all of your views directly into the **Django project**'s `urls.py`. However, as you start increase your project's complexity you might end up with way too much within one file.
For simple **Django projects**, you can easily add all of your views directly into the **Django project's** `urls.py`. However, as you start increase your project's complexity you might end up with way too much within one file.

Once you reach that point, we recommend creating an individual `urls.py` within each of your **Django apps**.

Then, within your **Django project**'s `urls.py` you will use Django's [`include` function](https://docs.djangoproject.com/en/dev/ref/urls/) to link it all together.
Then, within your **Django project's** `urls.py` you will use Django's [`include` function](https://docs.djangoproject.com/en/dev/ref/urls/) to link it all together.
4 changes: 2 additions & 2 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
pip install django-idom
```

You'll also need to modify a few files in your Django project...
You'll also need to modify a few files in your **Django project**...

---

Expand All @@ -27,7 +27,7 @@ INSTALLED_APPS = [

Django-IDOM requires ASGI in order to use Websockets.

If you haven't enabled ASGI on your Django project yet, you'll need to add `channels` to `INSTALLED_APPS` and set your `ASGI_APPLICATION` variable.
If you haven't enabled ASGI on your **Django project** yet, you'll need to add `channels` to `INSTALLED_APPS` and set your `ASGI_APPLICATION` variable.

Read the [Django Channels Docs](https://channels.readthedocs.io/en/stable/installation.html) for more info.

Expand Down