docs: remove cost, document missing options and improve docs (lowlighter#653)

Author: lowlighter

.github/quickstart/plugin/metadata.yml

@@ -1,5 +1,4 @@
 name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
-cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
 category: other   # Set plugin category ("github", "social" or "other")
 supports:
   - user          # Support users account

.github/readme/partials/documentation/compatibility.md

@@ -10,7 +10,7 @@
   <tr>
     <td nowrap="nowrap"><%- name %></td><%# -%>
     <% for (const [plugin] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %>
-    <td nowrap="nowrap" align="center" data-plugin="<%= plugin %>"><%= readme.compatibility[plugin] ? "✔️" : "❌" %></td><% } %>
+    <td nowrap="nowrap" align="center" data-plugin="<%= plugin %>"><%= {true:"✔️", false:"❌", embed:"✓"}[readme.compatibility[plugin]] %></td><% } %>
   </tr><% } %>
   <tr>
     <td colspan="<%= Object.keys(plugins).length %>"></td>

CONTRIBUTING.md

@@ -423,8 +423,7 @@ For example:
 Here's an example:
 ```yaml
 name: "🧩 Plugin name (with emoji icon)"
-cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
-category: github # Plugin category ("github", "social" or "other")
+category: github  # Plugin category ("github", "social" or "other")
 index: ~          # Leave as it (this is used to order plugins on metrics README.md)
 supports:
   - user          # Support users account

source/app/metrics/metadata.mjs

@@ -297,7 +297,10 @@ metadata.template = async function({__templates, name, plugins, logger}) {
       supports:meta.supports ?? null,
       readme:{
         demo:readme.match(/(?<demo><table>[\s\S]*?<[/]table>)/)?.groups?.demo?.replace(/<[/]?(?:table|tr)>/g, "")?.trim() ?? (name === "community" ? '<td align="center" colspan="2">See <a href="/source/templates/community/README.md">documentation</a> 🌍</td>' : "<td></td>"),
-        compatibility:{...compatibility, base:true},
+        compatibility:{
+          ...Object.fromEntries(Object.entries(compatibility).filter(([_, value]) => value)),
+          ...Object.fromEntries(Object.entries(compatibility).filter(([_, value]) => !value).map(([key, _]) => [key, "embed"])),
+        },
       },
       check({q, account = "bypass", format = null}) {
         //Support check

source/plugins/achievements/README.md

@@ -36,9 +36,10 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
   with:
     # ... other options
     plugin_achievements: yes
-    plugin_achievements_threshold: B       # Display achievements with rank B or higher
-    plugin_achievements_secrets: yes       # Display unlocked secrets achievements
-    plugin_achievements_ignored: octonaut  # Hide octonaut achievement
-    plugin_achievements_limit: 0           # Display all unlocked achievement matching threshold and secrets params
-    plugin_achievements_display: compact   # Use compact display
+    plugin_achievements_threshold: B      # Display achievements with rank B or higher
+    plugin_achievements_secrets: yes      # Display unlocked secrets achievements
+    plugin_achievements_display: compact  # Use compact display
+    plugin_achievements_limit: 0          # Display all unlocked achievements (no limit)
+    plugin_achievements_ignored: octonaut # Hide "octonaut" achievement
+    plugin_achievements_only: explorer    # Display only "explorer" achievement (don't use with "ignored" option)
 ```

source/plugins/achievements/metadata.yml

@@ -1,5 +1,4 @@
 name: "🏆 Achievements"
-cost: ~5 GraphQL request
 category: github
 index: 17
 supports:

source/plugins/activity/README.md

@@ -38,7 +38,11 @@ Use a full `repo` scope token to display **private** events.
   with:
     # ... other options
     plugin_activity: yes
-    plugin_activity_limit: 5    # Limit to 5 events
-    plugin_activity_days: 14    # Keep only events from last 14 days (can be set to 0 to disable limitations)
-    plugin_activity_filter: all # Show all events (use table above to filter events types)
+    plugin_activity_limit: 5           # Limit to 5 events
+    plugin_activity_load: 100          # Load up to 100 recent events from API (should be higher than "limit")
+    plugin_activity_days: 14           # Keep only events from last 14 days (set to 0 for no limit)
+    plugin_activity_filter: all        # Show all events (use table above to filter events types)
+    plugin_activity_visibility: public # Only display public events
+    plugin_activity_timestamps: yes    # Display events timestamps
+    plugin_activity_skipped: repo      # Ignored repositories
 ```

source/plugins/activity/metadata.yml

@@ -1,5 +1,4 @@
 name: "📰 Recent activity"
-cost: 1 REST request per 100 events
 category: github
 index: 16
 supports:
@@ -86,4 +85,4 @@ inputs:
     type: array
     format: comma-separated
     default: ""
-    example: my-repo-1, my-repo-2, owner/repo-3 ...
+    example: my-repo-1, my-repo-2, owner/repo-3, ...

source/plugins/anilist/README.md

@@ -32,10 +32,10 @@ These sections can also be filtered by media type, which can be either `anime`,
   with:
     # ... other options
     plugin_anilist: yes
-    plugin_anilist_medias: anime, manga             # Display both animes and mangas
-    plugin_anilist_sections: favorites, characters  # Display only favorites and characters sections
-    plugin_anilist_limit: 2                         # Limit to 2 entry per section (characters section excluded)
-    plugin_anilist_shuffle: yes                     # Shuffle data for more varied outputs
-    plugin_anilist_user: .user.login                # Use same username as GitHub login
-    plugin_anilist_limit_characters: 22             # Limit to 22 characters in characters section
+    plugin_anilist_medias: anime, manga            # Display both animes and mangas
+    plugin_anilist_sections: favorites, characters # Display only favorites and characters sections
+    plugin_anilist_limit: 2                        # Limit to 2 entry per section (characters section excluded)
+    plugin_anilist_limit_characters: 22            # Limit to 22 characters in characters section
+    plugin_anilist_shuffle: yes                    # Shuffle data for more varied outputs
+    plugin_anilist_user: .user.login               # Use same username as GitHub login
 ```

source/plugins/anilist/metadata.yml

@@ -1,5 +1,4 @@
 name: "🌸 Anilist watch list and reading list"
-cost: N/A
 category: social
 index: 4
 supports: