Total control: Creating our own solution is probably the most secure way to be sure to have the ability to add any custom feature. Well, at this point we knew what we wanted, so started comparing options.Īs developers, we all have the reflex to create our own tools, but doing that requires a lot of development time: Internationalization: English is the default language but the documentation will be probably translated in the future.Search: The documentation should be searchable to make information easy to find.v1 documentation: Both v1 and v3 documentation had to be still available in the same place.Customization: We didn't want to get stuck because of a lack of customizations possibilities.Low development time: We did not have weeks to spend on developing a new static documentation generator.Markdown syntax makes contributions clearer and is natively interpreted by GitHub.
#Gitbook editor login full#
Markdown syntax: Maintaining a full HTML documentation can become very confusing: a single tag error can break the entire documentation or simply the design itself.Versioning the documentation in the same repository was a piece of evidence to make sure that it is up-to-date before each pull request acceptation. Contribution in the mono-repository: In its latest version, every Strapi core module is developed and maintained in a single GitHub repository.The ideal solution should not prevent us from doing that. Compatible with the new website: At this point we already knew that the new website would be a Strapi v3 application rendering views.We didn't know what tool to choose, but we had clear needs for our documentation: In this article, we will explain how we did it.ĭisclaimer: the arguments listed here are ours and may vary for other projects. To do so, we had to choose a great workflow and decided to make Gitbook a key part of it. In this context, we entirely rewrote the documentation and decided to make its contribution as easy as possible. Last month, we proudly published a new version of Strapi and our brand new website.
0 kommentar(er)
