←back to thread

We Designed TigerBeetle's Docs from Scratch

(tigerbeetle.com)
71 points mooreds | 3 comments | 07 Apr 25 12:35 UTC | HN request time: 0.218s | source
Show context
bryanhogan ◴[10 Apr 25 16:52 UTC] No.43645805[source]▶
Docusaures isn't the best documentation tool out there, that's true. And of course building your own thing is nice, and it looks great. But wouldn't the better option be, to just use Starlight (my preference), Vitepress or Nextra?
replies(1): >>43647672 #
genericperson66 ◴[10 Apr 25 20:18 UTC] No.43647672[source]▶
Why do we live in a world where a simple docs site is considered too complex to roll your own and requires humongous frameworks?
replies(1): >>43650630 #
1. bryanhogan ◴[11 Apr 25 04:59 UTC] No.43650630[source]▶
Because a "simple" docs site takes weeks or months of work that you could invest into other projects instead. What about Starlight or Vitepress is humongous? In this case the downsides don't outweigh the upsides, at least that was my first thought, hence I asked.
replies(2): >>43650946 #>>43652189 #
2. jorangreef ◴[11 Apr 25 06:10 UTC] No.43650946[source]▶
Except, this didn’t take longer.

In fact, it would have taken longer had we had to “sculpt” the dependencies.

But—we also wouldn’t have had the same quality.

Again, I don’t mean to suggest that you should necessarily “paint” like we do at TigerBeetle, but we’re happy with the time and quality of the project, that it (more than) met our standard.

We’re not trying to impose TigerStyle on you, but it works for us.

3. genericperson66 ◴[11 Apr 25 09:55 UTC] No.43652189[source]▶
Got you, I think the article made it clear that this solution did in fact not take months of work, as the heavy lifting is done by pandoc. The resulting solution is also very simple and can be understood completely in a short amount of time (very big upside). A framework based on node, typescript, npm etc. is by humongous by default.