DEV Community

NextBlock
NextBlock

Posted on

Documentation is a Feature: Why I’m Obsessing Over "Time-to-Hello-World"

Great code with bad docs is just legacy code waiting to happen.

We just finished the "Holiday Sprint" for NextBlock, hitting 100% Lighthouse scores and shipping a robust Plugin SDK. But the code is only half the battle.

I’m spending the days between Christmas and New Year's doing the unglamorous work: Writing Docs. ✍️

My Goal for Jan 1st: A developer should be able to run npx create-nextblock-app and have a running, deployed CMS in under 5 minutes.

If you have to read a 10-page manual to start a server, I’ve failed.

I’m looking for beta testers to try the installation flow next week. If it takes you longer than 5 minutes, I want to hear about it.

Who is up for the challenge?

The read me in the repo: https://github.com/Webman-Dev/nextblock-monorepo

Top comments (0)