Springwolf has reached a point, where it supports essential use-cases and provides great value to users that don鈥檛 want to write (much) documentation themselves. Now it鈥檚 time to expand our user base by promoting the project. Zenika open source has a great guide on improving open source projects. Over the past months we鈥檝e been working on making Springwolf better to build a solid foundation. One of the next suggestions is to write an article....
2023 seems to be once again the year of AIs. The year, in which everyone can test out the latest revolutionizing developments from their home and is actually impressed. Springwolf鈥檚 new logo And so, we tried it out as well. We were looking for a logo for the springwolf open source project. Neither of us are graphics designer nor have a budget to hire one. And, we also have no specific design in mind....
While Springwolf comes with an own ui called springwolf-ui, the AsyncApi community has build also a feature-rich visualization for AsyncApi documents. Their project is called asyncapi-react. Turns out, it is easy to combine the asyncapi-react project to render springwolf api docs. Why? Because springwolf generates AsyncApi compliant spec documents that can be visualized with any AsyncApi compliant ui tool. You can use springwolf-asyncapi-ui as an alternative or in addition to the existing springwolf-ui project....
About a year ago, we started looking into ways to document our event-driven Kafka API and decided on using springwolf. We enjoy its capabilities to extract documentation from code, similar like Swagger and springfox, but soon noticed that we need additional features. This is my story about getting into open source. Springwolf is/was at that point a comparatively small project, which is actively developed and has (semi-)regular releases. It is also a great fit for getting started as there are no long guidelines on how to contribute and approval process....