Skip to content

Commit ca2c583

Browse files
jchristgitMarkKoz
andcommitted
Reword documentation per review
Co-authored-by: MarkKoz <[email protected]>
1 parent c0666e5 commit ca2c583

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

pydis_site/apps/content/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# The "content" app
22

3-
This application serves static, markdown-based content. Django-wise there is
4-
relatively little code in there, most of it is concerned with serving our
3+
This application serves static, Markdown-based content. Django-wise there is
4+
relatively little code in there; most of it is concerned with serving our
55
content.
66

7-
The markdown files hosting our content can be found in the
8-
[`resources/`](./resources) directory, and contain
9-
107

118
## Contributing pages
129

13-
Contributing pages is covered extensively in our online guide, which you can
14-
find
15-
[here](https://www.pythondiscord.com/pages/guides/pydis-guides/how-to-contribute-a-page/)
16-
or alternatively read it directly at
10+
The Markdown files hosting our content can be found in the
11+
[`resources/`](./resources) directory. The process of contributing to pages is
12+
covered extensively in our online guide which you can find
13+
[here](https://www.pythondiscord.com/pages/guides/pydis-guides/how-to-contribute-a-page/).
14+
Alternatively, read it directly at
1715
[`resources/guides/pydis-guides/how-to-contribute-a-page.md`](./resources/guides/pydis-guides/how-to-contribute-a-page.md).
1816

1917

@@ -25,13 +23,13 @@ Let's look at the structure in here:
2523
[pages](https://www.pythondiscord.com/pages/)
2624

2725
- `migrations` contains standard Django migrations. As the `content` app
28-
contains purely static markdown files, no migrations are present here.
26+
contains purely static Markdown files, no migrations are present here.
2927

3028
- `tests` contains unit tests for verifying that the app works properly.
3129

32-
- `views` contains our Django views generating and serving the pages from the
33-
input markdown.
30+
- `views` contains Django views which generating and serve the pages from the
31+
input Markdown.
3432

3533
As for the modules, apart from the standard Django modules in here, the
36-
`utils.py` module contains utility functions for discovering markdown files to
37-
serve on the filesystem.
34+
`utils.py` module contains utility functions for discovering Markdown files to
35+
serve.

0 commit comments

Comments
 (0)