refactor: adjusted file structure for extension descriptions (#22)

paranext · Jul 2, 2024 · 6618a9a · 6618a9a
2 parents 7ecd681 + 91edebb
commit 6618a9a
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -55,10 +55,11 @@ This is a webpack project configured to build Platform.Bible extensions. The gen
       - `src/types/<extension_name>.d.ts` is this extension's types file that defines how other extensions can use this extension through the `papi`
       - `*.web-view.tsx` files will be treated as React WebViews
       - `*.web-view.html` files are a conventional way to provide HTML WebViews (no special functionality)
-    - `assets/` contains asset files the extension and its WebViews can retrieve using the `papi-extension:` protocol. It is copied into the build folder
-    - `contributions/` contains JSON files the platform uses to extend data structures for things like menus, settings, and descriptions. The JSON files are referenced from the manifest
-      - `contributions/displayData.json` contains (optionally) a path to the extension's icon file as well as text for the extension's display name, short summary, and path to the full description file
-      - `contributions/description-<locale>.md` contains a brief description of the extension in the language specified by `<locale>`
+    - `assets/` contains asset files the extension and its WebViews can retrieve using the `papi-extension:` protocol, as well as textual descriptions in various languages. It is copied into the build folder
+      - `assets/displayData.json` contains (optionally) a path to the extension's icon file as well as text for the extension's display name, short summary, and path to the full description file
+      - `assets/descriptions/` contains textual descriptions of the extension in various languages
+        - `assets/descriptions/description-<locale>.md` contains a brief description of the extension in the language specified by `<locale>`
+    - `contributions/` contains JSON files the platform uses to extend data structures for things like menus and settings. The JSON files are referenced from the manifest
     - `public/` contains other static files that are copied into the build folder
 - `dist/` is a generated folder containing the built extension files
 - `release/` is a generated folder containing zips of the built extension files