flowfile-docs-and-writing
CommunityMaster Flowfile documentation conventions for efficient writing and management.
AuthorEdwardvaneechoud
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill unit streamlines the process of writing, organizing, and maintaining documentation for the Flowfile project, ensuring clarity, consistency, and ease of access for both contributors and end-users.
Core Features & Use Cases
- Documentation Structure: Defines the organization and layout of the MkDocs site and CLAUDE.md files.
- Building and Deploying: Describes the workflow for building documentation locally and deploying it to GitHub Pages.
- House Style: Establishes the editorial standards and voice for documentation pages.
- Comment Doctrine: Outlines the guidelines for coding comments within the Flowfile codebase.
- CLAUDE.md Protocol: Details the maintenance and update protocol for the CLAUDE.md files across the repository.
Quick Start
Navigate to the 'docs/' directory and refer to the 'SKILL.md' file for instructions on writing and maintaining Flowfile documentation.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: flowfile-docs-and-writing Download link: https://github.com/Edwardvaneechoud/Flowfile/archive/main.zip#flowfile-docs-and-writing Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.