The tree-based approach to organizing documentation sucks

Re:The tree-based approach to organizing documentation sucks by tln on Wednesday March 10, 2021 @02:01PM (#26414763)

I like markdown inside the code repo for the precise reason that it is easy to maintain! Also it easy to review ("Hey, this PR should update docs/Testing.md"), and easy to be in sync with what's deployed.

At $WORK I've got our repos hooked up to Slab, where the wiki style docs also go, so any search in Slab finds the markdown files as well.

And WRT slack, many tools including Slab let you use /slash commands to find answers. So in response to a question, you can do a /slab search, and maybe even /slab create to start a stub for a topic.

[ Parent | on HN ]

Re:The tree-based approach to organizing documentation sucks by prepend on Wednesday March 10, 2021 @02:09PM (#26414856)

Sorry, what’s Slab? I couldn’t figure it out by googling “slab source.”

[ Parent | on HN ]

Re:The tree-based approach to organizing documentation sucks by sfg on Wednesday March 10, 2021 @02:21PM (#26414997)

> Slab

I'm guessing, it is https://slab.com/ ("The knowledge base that democratizes knowledge"), which I discovered by searching for "Slab for Slack".

[ Parent | on HN ]

Re:The tree-based approach to organizing documentation sucks by tln on Wednesday March 10, 2021 @02:33PM (#26415167)

Thanks, that's indeed the tool. Sorry I should have linked that.

[ Parent | on HN ]

Re:The tree-based approach to organizing documentation sucks by prepend on Wednesday March 10, 2021 @03:50PM (#26416037)

Thanks. Comically googling for “slab” didn't show slab.com, although it does now.

[ Parent | on HN ]