From f33d3535be5eb1bad6df1d765872b6db05b5fff3 Mon Sep 17 00:00:00 2001 From: jchristgit Date: Mon, 11 Dec 2023 14:00:08 +0100 Subject: [PATCH] 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. --- .../resources/guides/pydis-guides/contributing/site.md | 5 +++++ 1 file changed, 5 insertions(+) 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 404ff4293..1927f4492 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!