diff options
| author |  jchristgit <[email protected]> | 2023-12-11 14:00:08 +0100 |
|---|---|---|
| committer |  GitHub <[email protected]> | 2023-12-11 13:00:08 +0000 |
| commit | f33d3535be5eb1bad6df1d765872b6db05b5fff3 (patch) | |
| tree | a4f8c2b76c3b149bb53658151bc9aac1005bc530 /pydis_site/apps/content | |
| parent | Merge pull request #1164 from python-discord/the-pythondiscord-workers-server... (diff) | |
Mention READMEs for app dirs in contributing guide (#1168)
Allow people to figure out our repository structure easily after settnig
up the project.
Part of #673.
Diffstat (limited to 'pydis_site/apps/content')
| -rw-r--r-- | pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md index 404ff429..1927f449 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md @@ -183,4 +183,9 @@ Now that you have everything setup, it is finally time to make changes to the si If you're not sure where to go from here, our [detailed walkthrough](../#2-set-up-the-project), or the [guide on contributing a page](../../how-to-contribute-a-page) is for you. +The site repository also contains `README.md` files in all major directories of +interest, which explain where which functionality of the site is located. For +example, see the [API app's +README](https://github.com/python-discord/site/tree/main/pydis_site/apps/api). + Have fun! |