Customizable Documentation Made Easy
Collaborator: The Guild
The Guild is a group of developers committed to a sustainable approach to open source development. The Guild has created a remarkable ecosystem of GraphQL tools that are used by many big companies, including Microsoft, Uber, and Klarna.
With over 20 tools in their ecosystem, presenting and documenting them in a consistent manner can be challenging, especially if complete control over the look and feel is desired. Existing options such as Docusaurus provided a simple way to create documentation websites but were not customizable enough, so a custom solution had to be developed.
Softisfy's solution was to develop The Guild Components, a flexible and modern library of components that is an open-source NPM package. This library allows seamless integration with both existing and future documentation websites.
Our tech stack included React with Typescript, Tailwind CSS, and Storybook.
Once the library was implemented and validated by the client, all pre-existing documentation sites were updated with the main components, including the header and footer.
In a secondary step, we developed a custom documentation boilerplate, The Guild Docs, which matched the component library's style. The makeover was extended to critical tools like Envelop, incorporating both new solutions.
Presentation pagesbuilt with The Guild Components
Documentation pageusing The Guild Docs
Open Source Community
Revamp documentation websites
Documentation websites deployed
OS libraries contribution