From d026735580e2b987d5054dbb93a844d84c11e237 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Charaoui?= Date: Wed, 13 Dec 2023 11:09:04 -0500 Subject: [PATCH] README: reorganize sections --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 274235f3..4e78981f 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,9 @@ To help us to translate, please join the [Tor Project team](https://hosted.webla If you want to contribute to the Community portal, we will be happy to help you. Join us at #tor-www in [irc.oftc.net](https://www.oftc.net). -### The community-generator plugin +### Section-specific instructions -This lektor site uses a special plugin called `community-generator`, you can find it in the `packages` directory. This plugin generates a special set of lektor contents files used for a js-free filtering system on the training resources page. - -You shouldn't need to do anything or know anything about this plugin in order to use it. If you want to develop on this plugin, see the plugin's [README](packages/community-generator/README.md). +Instructions for maintaining specific sections of the website. #### Adding training guides for training resources @@ -98,3 +96,11 @@ pdf_link: link to the pdf guide ---- odp_link: link to the odp guide ``` + +## Design + +### The community-generator plugin + +This lektor site uses a special plugin called `community-generator`, you can find it in the `packages` directory. This plugin generates a special set of lektor contents files used for a js-free filtering system on the training resources page. + +You shouldn't need to do anything or know anything about this plugin in order to use it. If you want to develop on this plugin, see the plugin's [README](packages/community-generator/README.md).