Fork me on GitHub
#polylith
<
2022-09-07
>
Daniel Gerson08:09:57

Thanks for the great documentation on Polylith. FWIW, I thought that I'd say that I'd prefer a single page document more like the shadow-cljs user guide as I can easily Ctrl-S search in context, rather than googling site: in order to re-lookup something I've read but can't remember what page it's on.

james08:09:24

I guess that’s a tradeoff between easy search, and easy navigation/exploration.

james08:09:51

Have you tried Gitbook’s built-in search feature (top-right of the UI)? It’s actually pretty good, and will give you better results than CTRL + F.

tengstrand10:09:32

I just exported the high-level documentation of the latest release to https://github.com/polyfy/polylith/releases/download/v0.2.15-alpha/polylith-0-2-15-alpha.pdf pdf. It's not exactly what you want, but maybe good enough!

Daniel Gerson10:09:46

@U055RDVAV The problem with the search is that context is a very visually dependent and the search strips away at the formatting. (I also end up doing it twice between the poly book and the polylith book, which is why googling with site: works better). Note that I don't think a single page at all takes away from the navigation provided there is a side bar and large enough headings. @U1G0HH87L I imagine that might be better for me thanks, just a different workflow and have to manage the pdf version.

👍 1
tengstrand11:09:00

Yes, it's important that you can search all documentation easily. When we had all the documentation in a markdown document (or actually one for the high level doc, and one for the poly tool) with table of content links at the top, it was hard to jump between subjects. The left menu in Gitbook solved that problem, but introduced another, so yes, it would be nice if we could solve both problems in a good way. I don't think we should merge the high level doc and the poly tool doc, because they are two separate things, but I'm always up for change if someone has good arguments!

👍 1