Automatically pull toolshed descriptions #62

New Issue

2026-10-30T15:53:41Z

amras commented

2026-10-30 15:53:41 +00:00

Proposal

Add a "short description" section to each README.md in important toolkit repos: abra, alakazam, backup-bot-two, (etc?).
Add a shortcode which pulls the short description. Example here
Use the shortcode to ensure all tools listed in https://coopcloud.tech/toolshed use information from the READMEs. Example

Motivation

Following Living Documentation principles:

keep docs close to the code
single source of truth
reduntant places to view information should automatically sync

Priority

Low/Nice to have - these tools rarely change their description.

## Proposal 1. Add a "short description" section to each README.md in important toolkit repos: abra, alakazam, backup-bot-two, (etc?). 2. Add a shortcode which pulls the short description. [Example here](https://git.coopcloud.tech/toolshed/coopcloud.tech/src/commit/491f4451ce33eb83c2def2adb2851581bcccdc4c/themes/coopcloud.tech/layouts/shortcodes/include.html) 3. Use the shortcode to ensure all tools listed in https://coopcloud.tech/toolshed use information from the READMEs. [Example](https://git.coopcloud.tech/toolshed/coopcloud.tech/src/commit/491f4451ce33eb83c2def2adb2851581bcccdc4c/content/toolshed.md?display=source) ## Motivation Following Living Documentation principles: - keep docs close to the code - single source of truth - reduntant places to view information should automatically sync ## Priority Low/Nice to have - these tools rarely change their description.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: toolshed/coopcloud.tech#62