// the find
willmcgugan/faqtory
A tool to generate FAQ.md documents and automatically suggest answers to issues
FAQtory generates a FAQ.md from a folder of markdown question files and can fuzzy-match incoming GitHub issue titles against that FAQ to post automated suggestions. It's aimed at open-source maintainers who are drowning in repeat questions. Small scope, does one thing.
The fuzzy-match suggest feature piped into a GitHub Action is the genuinely useful part — it costs nothing to run and can deflect a real percentage of duplicate issues. The question format (front-matter markdown with alt_titles) is simple enough that contributors can add entries without reading any docs. The CLI init/build workflow is straightforward and has no runtime dependencies to manage if you use pipx.
The fuzzy matching is dumb string similarity — no embeddings, no semantic search — so 'how do I install X' and 'installation instructions' may not match even though they should. The project is effectively abandoned; last commit is early 2024 and the README itself says it was 'hastily put together'. There's no way to organize questions into categories or sections, so a large FAQ will be a flat unsorted list. The template system is minimal and underdocumented — if you want to change the output format you're reading source code.