foam-docs

Enforces documentation structure and gathers context from Foam knowledge bases.

Updated Jan 13, 2026
One-click install
npx skills add https://github.com/laviefatigue/charm-email-os --skill foam-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: foam-docs
Source: https://github.com/laviefatigue/charm-email-os/tree/main/.claude/skills/foam-docs
Command: npx skills add https://github.com/laviefatigue/charm-email-os --skill foam-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Foam documentation often lacks consistent structure and frontmatter, making it hard to navigate and generate reliable context.

Core Features & Use Cases

  • Enforces YAML frontmatter presence and required fields (title, created, updated, tags) across Foam docs.
  • Encourages bidirectional linking and hub/Map of Content (MOC) patterns to improve discoverability.
  • Provides workflow guidance for creating/updating README, ADRs, guides, and references within docs/ or foam/ directories.

Quick Start

Activate the Foam Docs skill by pointing it at a Foam project root (docs/ or foam/) and instruct it to validate or update the current document.

Frequently Asked Questions about foam-docs

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

FAQPage Schema
How do I enforce consistent frontmatter in Foam documentation?

You can enforce YAML frontmatter in Foam by validating required fields like title, created, updated, and tags across your notes. The Skill checks documents within docs/ or foam/ directories to ensure metadata compliance.

What is the best way to organize a Foam knowledge base using Map of Content?

Organizing a Foam knowledge base with Map of Content (MOC) involves using bidirectional wiki-links and hub structures to improve discoverability. The Skill provides workflow guidance to establish these MOC patterns within your documentation directories.

Can I use this to create Architecture Decision Records in a markdown wiki?

Yes, you can create Architecture Decision Records (ADRs) in a markdown wiki. The Skill provides workflow guidance for creating and updating ADRs alongside READMEs, guides, and references within docs/ or foam/ directories.

Why does my Foam documentation lack reliable context for navigation?

Foam documentation lacks reliable context when it misses consistent structure, frontmatter, and bidirectional wiki-links. The Skill solves this by enforcing conventions and promoting hub patterns to improve navigation.

Do I need a specific directory structure to validate markdown conventions?

You need a Foam project root containing a docs/ or foam/ directory to validate markdown conventions. The Skill targets these specific directory structures to gather context and enforce documentation rules effectively.