andrewrk/autodoc

The Zig Documentation Generator is a tool that takes Zig source code and turns it into an interactive, searchable website where people can browse the documentation for a Zig package. Think of it like the docs pages you see for popular libraries, you can search for a function or type, click through modules, and read doc comments, all in your browser without needing to open the code itself. The way it works is fairly straightforward at a high level. You give it a bundle of Zig source files (packaged as an uncompressed tar archive), and it processes them into a static web app. You then host those generated files on any basic web server. The app runs in the browser and lets users search and navigate the code's structure, modules, functions, types, and so on, without needing to compile or run anything themselves. The people who would use this are Zig developers or project maintainers who want to publish readable, searchable documentation for their libraries. For example, someone working on a Zig package could run this tool and publish the result online so that other developers exploring the library can quickly find what a function does, what types are available, or how different modules relate to each other. One notable thing about this project is that it has been archived because its functionality was merged directly into the main Zig compiler project. That means the work here is now part of Zig itself rather than living as a separate tool. The README also includes a long roadmap of improvements that were planned or still being considered, covering things like better search relevance, smarter handling of types and enums, and making source code viewable with clickable links between related definitions.