Show HN: Treedocs: Documentation that automatically checks for staleness

https://dandylyons.github.io/treedocs/

by DandyLyons • 29 days ago

53 19 29 days ago

dandylyons.github.io

DandyLyons7• 29 days ago

Hi HN,

I built treedocs, a CLI that shows a tree of your file structure, side-by-side with docs.

The idea is simple: your filesystem already tells you what exists, but not what each path is for. treedocs mirrors the file tree into a treedocs.yaml file and lets you define short descriptions, references, and links to files and folders. It can then render that back as a documented tree, detect drift when files move or disappear, and fail checks when descriptions are missing.

I originally wanted this for two related problems: 1. Helping humans acclimate to unfamiliar repositories faster. 2. Giving coding agents concise project context without forcing them to rediscover the repo structure over and over.

Some things it does: - treedocs init creates a treedocs.yaml - treedocs sync reconciles it with the filesystem - treedocs check catches stale entries and missing descriptions - treedocs explore implements progressive disclosure for efficient token usage. - Nested treedocs.yaml files act as documentation boundaries for delegated subtrees - The YAML format is backed by a public JSON Schema

I’d be interested in feedback on the file format, CLI ergonomics, and whether this kind of repo-level map is useful for your workflows.

gritzko• 29 days ago

The question is who maintains it. I think, LLM is the only practical option. In my agent rules, I tell it to maintain INDEX.md on each level. That takes 1 line of instruction and starting with an example file. Then, it self-maintains.

DandyLyons7• 29 days ago

In practice, the LLM, treedocs and I all work together to maintain it. treedocs finds missing and extra paths, and missing descriptions. The LLM writes descriptions. git makes sure I never forget to run treedocs sync. And I always have the ability to easily correct incorrect descriptions by the LLM, or add my own special instructions.

Sure the LLM can do all of that but it's a waste of a lot of tokens, and in my experience it often makes incorrect assumptions or doesn't realize certain details.

tekacs2• 29 days ago

This is lovely! I'd done something similar in my own setup.

I'm curious what your experience has been with fork/merge – why a monolithic file rather than something more diffuse?

DandyLyons7• 29 days ago

treedocs already has the ability to read multiple treedocs.yaml files. (I should probably document this better.) treedocs.yaml files can be "nested". So you would have one at the top of your repo, and then you could optionally have one or more in subdirectories. Then your top treedocs.yaml is responsible for the repo, but the subdirectory treedocs.yaml files are responsible for their own subdirectory. The idea is that you might have situations where you install a dependency and it clones a subdirectory. Well that subdirectory could just define its own treedocs.yaml.

So it doesn't have to be monolithic.

moralestapia• 29 days ago

Why is @DandyLyons' comment flagged and dead?

Like ... what's wrong with what he posted?

I've seen thousands of Show HNs here, for like a decade. Very similar to this.

What rule did he break?

tekacs2• 29 days ago

(In fairness to this poster, DandyLyons' post was in fact dead when we got here – I used vouch on it.) Probably just weird things that happen when making your first post on HN if it's heuristically not quite right / a Show HN / wordy?

blahaj• 29 days ago

Probably none, just got into HN's spam filter. When you have enough points you can vouche for it and if enough people do it gets reinstated, which is exactly what happened.

add-sub-mul-div• 29 days ago

Being here with zero activity other than self promotion.

DandyLyons7• 29 days ago

Idk. I did make some edits right after posting (just rewording stuff). Maybe the forum didn't like that?

simonw• 29 days ago

I believe HN has some automations now that flag posts that look like they were LLM generated. I got caught out by that recently (in a post that wasn't fully LLM generated but quoted a line that probably was.)

You can email the mods and they'll fix it.

matneyx• 29 days ago

Maaan, this seems so great except it's MacOS only.

DandyLyons7• 29 days ago

I only have a Mac to test on, but I am open to releasing on Linux or Windows if someone would help.

addedGone• 29 days ago

VMs?

miketromba• 29 days ago

This is very good - I have found that well-designed progressive disclosure systems like this tend to be far more effective and performant than cookie-cutter semantic / encoding-based RAG systems. Agents seem to love tables of contents.

DandyLyons7• 29 days ago

It definitely feels more correct from a first principles perspective. It always seemed crazy that we often just throw a bunch of data at an LLM and go figure it out. It's filled with irrelevant junk. That would slow us down so why wouldn't it slow down AI?

Though I will say it has been a challenge to get agents to reliably use tools like `treedocs explore`. They tend to default to using their built in tooling first or commands like grep. I'm still working on reliable prompts and skills that tell the agent when to use which approach.

tristanMatthias• 29 days ago

I made a similar kind of tool [0] to scratch this itch too. Hashes all your files and adds a short llm summary for each one so Claude/Codex can quickly explore rather than load all those files into context.

[0] https://github.com/tristanmatthias/llmdoc

DandyLyons7• 29 days ago

Starred

tybnty• 26 days ago

I like the idea and was eager to give it a try but unfortunately there is no linux release yet.

Curious about why did you choose swift for this project?

Show HN: Treedocs: Documentation that automatically checks for staleness

Related Stories