{"repo":"czottmann/interfazzle","free":true,"listed":false,"github":"https://github.com/czottmann/interfazzle","clone":"git clone https://github.com/czottmann/interfazzle.git","description":"A Swift CLI tool for building simple Markdown docs for a package's public interface from its symbol graphs. LLMs love that stuff, too!","language":"Swift","stars":23,"topics":["agents","documentation","documentation-tool","llm","llm-agents","markdown","swift"],"license":"MIT","category":"ai-agents","readme_excerpt":"Interfazzle A wee Swift CLI tool that builds Markdown documentation for a package's public interface from Swift symbol graphs. Its aimed at package maintainers. First and foremost, I built this for myself – it scratches my own itches! But it feels kinda useful, even more so now that many of us work with LLMs, and they need to read docs, too. To home in on that , I grilled various LLMs—okay, just Claude Code—about how they work with documentation files, having them explain in detail what doc structure is useful to them. I combined what I've learned there with what I (a certified human!) look for in docs, and here we are. Also, DocC and its dynamic-page nonsense is the Liquid Glass of documentation. There, I said it. Overview Interfazzle handles the complete documentation generation pipeline: 1. Validation : Verifies Package.swift exists in the current directory 2. Symbol Graph Generation : Uses Swift's built-in compiler to generate symbol graph JSON files 3. Markdown Conversion : Converts symbol graphs to interface-style Markdown documentation This approach replaces the old sourcedocs tool, which failed for me when the package includes dependencies with pre-built binaries. Demo See Demo folder for a dummy example package containing sources (in Demo/Sources/) and generated documentation (in Demo/docs/). Usage Quick Start Generate all documentation from your Swift package root: Requirements - macOS with Swift 6 (tested on Swift 6.0+) - Must be run from a directory containing Pac","default_branch":null,"files":null,"tree":[],"storefront":"/r/czottmann","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/czottmann/interfazzle/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}