skills.rest
Edwardvaneechoud
EdwardvaneechoudCOMMUNITY
Explore all skills by this author →
GitHub

flowfile-docs-and-writing

Organize and maintain Flowfile documentation with MkDocs site structure and house style guidelines.

340|27|Updated Nov 9, 2024
Search Tags:#MkDocs#CLAUDE.md#GitHub Pages#Documentation#Code comments
One-click install
npx skills add https://github.com/Edwardvaneechoud/Flowfile --skill flowfile-docs-and-writing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: flowfile-docs-and-writing
Source: https://github.com/Edwardvaneechoud/Flowfile/tree/main/.claude/skills/flowfile-docs-and-writing
Command: npx skills add https://github.com/Edwardvaneechoud/Flowfile --skill flowfile-docs-and-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about flowfile-docs-and-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure MkDocs documentation for a software project?▼

The CLAUDE.md protocol details the maintenance and update procedures for CLAUDE.md files across a repository. It establishes how contributors document project standards and maintain consistency within the codebase.

How do I deploy MkDocs documentation to GitHub Pages?▼

Deploying MkDocs to GitHub Pages involves building the documentation locally and following a specific deployment workflow. This process publishes the structured documentation site directly to the GitHub Pages environment.

What are the house style guidelines for writing technical documentation?▼

House style guidelines establish the editorial standards and voice for documentation pages. They ensure consistency across written content, defining the specific tone and formatting conventions contributors must follow.

What is the comment doctrine for writing code comments in a codebase?▼

The comment doctrine outlines the specific guidelines for coding comments within the codebase. It dictates how developers should annotate code to maintain clarity and standardize inline documentation practices.

Do I need a specific environment to build and deploy MkDocs locally?▼

Building and deploying MkDocs locally requires navigating to the 'docs/' directory and referring to the 'SKILL.md' file. This setup ensures you have the proper instructions for local builds and GitHub Pages deployment.

Related Skills

Explore More Software Engineering Skills→
tamago0224tamago0224

mkdocs-translations

Translate MkDocs documentation into a target language and update mkdocs.yml for i18n.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
avvaleavvale

conventional-commits

Validate commit messages against the Conventional Commits specification.

Official
Basic
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced