The docs for the Dapr SDKs live in their respective SDK GitHub repositories. The thought behind this was to make it easy for SDK contributors/maintainers to add new docs when they add new features. In reality, docs are frequently still an afterthought and are hardly ever in the same PR as the code changes.
Having the SDK docs is their separate repos also comes with some downsides:
- It's time consuming to preview & test SDK docs due to the current submodule approach in the main Docs.
- SDK docs frequently contain formatting issues which breaks the Hugo build.
- There are many variations in the SDK docs since they each live in their silo and it's too much effort to see how another language written their docs.
I'm proposing to move all the SDK (and Pluggable Component) docs into the main docs. This will allow all SDK maintainers to preview/test their docs easily and it will help align the structure of all SDK docs.
Once the SDK docs migration of is done, the only submodule that remains is the Chinese translation of the docs.
The docs for the Dapr SDKs live in their respective SDK GitHub repositories. The thought behind this was to make it easy for SDK contributors/maintainers to add new docs when they add new features. In reality, docs are frequently still an afterthought and are hardly ever in the same PR as the code changes.
Having the SDK docs is their separate repos also comes with some downsides:
I'm proposing to move all the SDK (and Pluggable Component) docs into the main docs. This will allow all SDK maintainers to preview/test their docs easily and it will help align the structure of all SDK docs.
Once the SDK docs migration of is done, the only submodule that remains is the Chinese translation of the docs.