doc-forms

Annotate Scheme code with typed, searchable doc forms for The Fold.

7|Updated Dec 25, 2025
One-click install
npx skills add https://github.com/osoleve/the-fold --skill doc-forms
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-forms
Source: https://github.com/osoleve/the-fold/tree/main/.claude/skills/doc-forms
Command: npx skills add https://github.com/osoleve/the-fold --skill doc-forms

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Fold uses typed comments and doc forms to turn scattered inline notes into searchable, versioned metadata that travels with code.

Core Features & Use Cases

  • Typed annotations: add type, description, and parameter metadata alongside Scheme definitions without changing runtime behavior.
  • Searchable docs: enables tooling to index and retrieve documentation across a project.
  • Module-level documentation: promote consistent documentation practices across functions and modules, with support for tooling integration.
  • Use Case: annotate a function with (doc 'type ...) and (doc 'description "Adds two numbers") so teammates can discover semantics via search.

Quick Start

Start annotating a simple Scheme function with doc forms, then run your documentation indexer to verify docs are discoverable.

Frequently Asked Questions about doc-forms

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

FAQPage Schema
How do I add searchable documentation to Scheme code?

You can add searchable documentation to Scheme code by annotating definitions with typed doc forms like (doc 'type ...) and (doc 'description ...), which tooling then indexes without altering runtime behavior.

What is a typed doc form in Scheme?

A typed doc form in Scheme is a metadata annotation, such as (doc 'type ...) or (doc 'description "..."), attached to definitions to unify type, description, and parameter notes across a codebase.

Does adding doc annotations change Scheme runtime behavior?

No, adding doc annotations does not change Scheme runtime behavior. The (doc ...) tags function as typed comments that tooling reads and indexes, leaving the actual execution of definitions and modules unaffected.

How do I index module-level documentation across a Scheme project?

To index module-level documentation across a Scheme project, annotate functions and modules with typed doc forms, then run your documentation indexer to verify the metadata is discoverable via search.

Can I use doc forms for Scheme projects not using The Fold?

Doc forms require support for (doc ...) tags and tooling that reads and indexes them. They are designed for projects using The Fold where developers need consistent type, description, and parameter metadata attached to definitions.