Please add more examples or a demo page or something. The gif and picture in the github repo is the single most descriptive part of your documentation, but a gif is terrible UX and a picture doesn't show off interactivity. This should be front and center on your landing page.
This may be useful for me, but I'm not going to bother setting up a test Django environment to test this just to find out that it isn't what I expected.
The docs has a lot of examples, especially the cookbook. For example: https://docs.iommi.rocks/cookbook_tables.html
In the docs, if you click on the links "forms" or "tables", that will lead to the docs for those parts with a few example, and that in turn links to the cookbooks.
There's also my talk from Django Days: https://www.youtube.com/watch?v=ydRdbA_tXdw&pp=ygUXYW5kZXJzI...
Thanks, looks interesting. I may play around with it.
I think what happened was that I landed on your page. Read the landing page, which only contained code. Scrolled to the top and clicked "install in minutes" and was unexpectedly redirected down the page. Then I clicked into github and didn't click on the forms/tables hyperlinks there.
I think what I'm saying is primarily that I'm lazy.
Secondly, your landing page is too code oriented and does not show off any UI and your anchor link (which typically links into documentation) short-circuited my search for a docs page.
I think you would have gotten considerably more upvotes on this post if you show the product off more on the landing page. Despite the obvious lack of effort I put into learning your product, most people who clicked on this link today did even less.
No shade or anything. Again, the product looks nice now that I've seen it in the docs.
All good feedback. Thanks.
Same. But I have now a new secret weapon, this claude code prompt:
Read the doc of https://iommi.rocks/, make a demo project showing of the capability of this tool.
(I have a claude.md with more info, but that's the prompt)
Came back with a fully functional demo with everything installed and working. runserver, and a glance at the code, and I get it.
TL;DR: it's like the django admin, except you can use it in any endpoint in your side. Pretty nice.
There's an example app too: https://github.com/iommirocks/iommi/tree/master/examples
I've had mixed success with Claude. It keeps adding too much display_names to everything for example which is annoying.
In theory we could put that up, but I don't particularly want to maintain such a live example app and pay for hosting and all that, only to have it instantly crash under the load of HN :P
BTW, your "https://kodare.net/2025/08/08/documentation-that-is-never-wr..." is fantastic, I always liked the idea of docstest, only the implementation sucked.
But this is much better. Any plan on open sourcing this infra for sphinx or mkdocs?
Thanks.
I've thought about extracting it, but I think it's a lot of work unless you want to support only Django and rST which is what we're using. At least the iframe part is very specific to the web framework.