Home / Companies / Tinybird / Blog / Post Details
Content Deep Dive

We rebuilt our docs from scratch. It was worth it.

Blog post from Tinybird

Post Details
Company
Date Published
Author
Julia Vallina Garcia
Word Count
2,782
Language
English
Hacker News Points
-
Summary

Revamping Tinybird's documentation was a comprehensive process driven by the need for a more dynamic, personalized, and scalable platform. The previous Sphinx-based system was deemed inadequate for future needs, lacking features like easy personalization, integration with Auth0, and a smooth workflow for the product and engineering teams. The team, led by Julia and Lucy Mitchell, opted to build a new system from scratch using Next.js for its flexibility and familiarity, supplemented by Markdoc for documentation, and hosted on Vercel with Tailwind CSS for styling. Key features such as personalized user experiences, dynamic code snippets, and streamlined search capabilities were prioritized, while maintaining accessibility and preparing for future enhancements like AI-powered help and advanced image optimization. The new documentation infrastructure is hosted in a dedicated repository to facilitate open-source collaboration and ensure seamless scalability, reflecting a strategic shift towards a more user-friendly and integrated documentation experience.