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.

Sign up for GitHub

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

Minor docs styling, formatting, and grammar improvements #76

Changes from 2 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c8f9ed3
Minor readme cleanup
Archmonger Jun 2, 2022
f4fafa1
Minor grammar cleanup
Archmonger Jun 2, 2022
6034bf0
Remove "next section" from footer
Archmonger Jun 2, 2022
6a66377
Remove "Made with mkdocs" from footer
Archmonger Jun 2, 2022
15a300f
Refresh on changes made to readme and changelog
Archmonger Jun 2, 2022
9faa217
Add copyright to footer
Archmonger Jun 2, 2022
2916b94
Automatically change color scheme based on system theme
Archmonger Jun 2, 2022
1897791
Pin navbar color to black
Archmonger Jun 2, 2022
6decda0
Put "Django developer" assumption into a tip box
Archmonger Jun 2, 2022
bcbacd9
clean up Enable Django ASGI warning
Archmonger Jun 2, 2022
19ec4db
bold "Django Project"
Archmonger Jun 4, 2022
6b27fb0
"Learning Django first is recommended!"
Archmonger Jun 4, 2022
18c9531
change tagline to "ReactJS for Django Developers"
Archmonger Jun 5, 2022
682ff60
add "Looking for more hooks?"
Archmonger Jun 5, 2022
0581f77
add more details to HelloWorld readme paragraph
Archmonger Jun 5, 2022
2925eb4
update notice on Use Location hook
Archmonger Jun 6, 2022
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
13 changes: 7 additions & 6 deletions docs/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--dj-proj-start-->
???+ tip "Learn Django before reading these docs!"

These docs assumes you have created [a basic **Django project**](https://docs.djangoproject.com/en/dev/intro/tutorial01/), which also involves generating/installing at least one **Django app**. If not, check out this [9 minute YouTube tutorial](https://www.youtube.com/watch?v=ZsJRXS_vrw0) created by _IDG TECHtalk_.

<!--dj-proj-end-->
<!--dj-proj-start-->These docs assumes you have created [a basic **Django project**](https://docs.djangoproject.com/en/dev/intro/tutorial01/), which also involves generating/installing at least one **Django app**. If not, check out this [9 minute YouTube tutorial](https://www.youtube.com/watch?v=ZsJRXS_vrw0) created by _IDG TECHtalk_.<!--dj-proj-end-->

## Install from PyPI

Expand All @@ -25,11 +23,14 @@ INSTALLED_APPS = [
]
```

??? warning "Enabling ASGI on Django (Required)"
??? warning "Enable Django ASGI (Required)"

Django-IDOM requires ASGI in order to use Websockets.

If you haven't [enabled ASGI](https://channels.readthedocs.io/en/stable/installation.html) 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.

```python title="settings.py"
INSTALLED_APPS = [
"channels",
Expand Down