doc: hint on plugin's repository name
Massimo Melina committed
Jan 25, 2025 at 19:01 UTC
00b8c523b806e218a55f1e0847367dffb7d0d092
1 file changed
+4
-1
dev-plugins.md
+4
-1
@@ -634,7 +634,10 @@ You can decide if you want to use some building system/transpiler, but you'll ha
634
635
Suggested method for publishing is to have a dedicated repository on GitHub, with topic `hfs-plugin`.
636
To set the topic go on the repo home and click on the gear icon near the "About" box.
637
-Be sure to also fill the "description" field, especially with words that people may search for.
637
+Be sure to also fill the "exports.description" field, especially with words that people may search for.
638
+
639
+If the name of the repository has the prefix "hfs-", it won't be displayed. Eg: "hfs-chat" will be displayed as "chat".
640
+This is good way to have a clearer repository name on github, while avoiding being redundant within the context of the HFS' UI.
641
642
The files intended to be installed must go in a folder named `dist`.
643
You can keep other files outside.