After going through all the surfaces of Tuist to ensure they speak the language of Noora, our design system, one surface remained inconsistent with the rest: our documentation site, so we embarked on changing that. Today, we rolled out our new documentation site. As part of this effort:
- We’ve moved away from VitePress to rendering the docs from our server with markdown files processed at compile time. This opens a world of opportunities to make our docs more dynamic by leveraging our server-rendering pipeline. Expect more interactive pages and guides that don’t require you to go to the dashboard to take actions.
- We’ve revamped our search experience. You can now search across not just the documentation pages but also GitHub issues, Community forum topics, and one of the most-requested ones: the project description symbols.
The documentation site is part of Tuist’s ecosystem and requires constant iteration, and we are not there yet. While this work focused on the frontend, there’s a lot of work to reflect the build-system agnosticism we are building into the product. Regardless of the build system that brought you to the documentation site, you should be able to find the information you need without clicking around. In the following weeks, we’ll invest in our information architecture, loosening the coupling with Apple’s Xcode toolchain, and reflecting the direction that we have for the platform to become a developers’ platform team.
I expect issues to arise, for example, broken links or bugs. If you find anything, just let me know, and we’ll fix those. Also, if you have ideas for guides that you’d love to see in our docs. Let me know.
Kudos once again to @asmit for the brilliant design work here. The investment that we made in designing and building a design system is paying great dividends.
