How do doc forms interact with the type checker?

Doc forms are authoritative. If you declare a type using (doc 'type ...), the type checker will prioritize this declaration over its own automated inference.

What is the difference between a doc todo and a BBS issue?

Use doc todos for localized, code-specific notes like refactoring or performance tweaks. Use BBS issues for tracked features, bugs, or cross-cutting concerns that need to be scheduled.

Can I search for all todos in my project?

Yes, by loading the meta/docs library, you can use the (lf-todo) command to find all todos or (lf-types) to list all type annotations in the codebase.

Does adding a doc form change the behavior of my code?

No. Doc forms are pure metadata. Their arguments are not evaluated, and they return void, meaning they are stripped during normalization and do not affect the code's hash or execution.

Doc Forms & Type Annotations

Name: Doc Forms & Type Annotations
Author: osoleve

byosoleve

•

학습 및 문서화

Implements a structured metadata system for Scheme code using searchable, introspectable doc forms.

The Doc Forms skill provides a standardized framework for adding type annotations, metadata, and inline documentation to Scheme code within The Fold environment. It enables developers to use (doc ...) syntax to define types, parameter descriptions, and return values that are authoritative for the type checker and LSP. Because these forms are normalized out during hashing, they provide rich introspection and searchable todo lists without altering the semantic identity of the code, making it an essential tool for managing complex agentic AI skill trees.

주요 기능

01Standardized tags for parameters, returns, deprecations, and versioning.

02Authoritative type annotations that override inference for the type checker.

03Non-evaluating metadata that is stripped during normalization to preserve code hashes.

045 GitHub stars

05Integrated search commands for codebase-wide todo and type extraction.

06Contextual and targeted documentation syntax using the (doc ...) form.

사용 사례

01Managing localized technical debt and refactoring notes using inline (doc 'todo ...) tags.

02Creating searchable, human-readable documentation for large-scale Scheme repositories.

03Defining explicit type signatures for complex functions to assist the LSP and type checker.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add osoleve/the-fold doc-forms

For use in Claude.ai and ChatGPT

Download Skill