Where in the README does it make changes?

The skill specifically targets the Features section, typically starting around line 12, ensuring it only updates the module list without affecting other content.

Will it overwrite my custom README descriptions?

The skill is designed to only update the bulleted list under the 'Daily logging of your life' parent item, preserving the rest of your README content.

What does the Modules README Updater do?

It automatically scans your journal modules and lists them alphabetically under the Features section of your README.md file to ensure documentation matches the codebase.

How do I trigger the update?

You can use this skill whenever you add a new module, remove an old one, or rename existing modules to keep your public documentation perfectly in sync.

Does it support manual module reordering?

No, the skill enforces strict alphabetical ordering to maintain a consistent, clean, and predictable documentation structure for all users.

Journal Module Documentation Sync

Name: Journal Module Documentation Sync
Author: djaiss

bydjaiss

•

Learning & Documentation

Automates the synchronization of journal modules within the project README to ensure feature documentation remains accurate and organized.

About

This skill maintains the JournalOS README by automatically detecting and listing all available tracking modules—such as sleep, mood, and health—under the Features section. It ensures that whenever a module is added, renamed, or removed, the project's documentation reflects the current state of the codebase with perfect alphabetical ordering and consistent Markdown formatting. By automating this maintenance task, it helps developers keep their documentation in sync with their features without manual intervention.

Key Features

Alphabetical sorting of all journal categories
Zero-configuration synchronization of module changes
Automatic module discovery and listing
Precise targeting of the README Features section
1 GitHub stars
Consistent Markdown list indentation and formatting

Use Cases

Maintaining an up-to-date module inventory during project reorganization
Standardizing the visual layout of the project features list
Syncing documentation after adding a new custom tracking module

About

Key Features

Alphabetical sorting of all journal categories
Zero-configuration synchronization of module changes
Automatic module discovery and listing
Precise targeting of the README Features section
1 GitHub stars
Consistent Markdown list indentation and formatting

Use Cases

Maintaining an up-to-date module inventory during project reorganization
Standardizing the visual layout of the project features list
Syncing documentation after adding a new custom tracking module