CLOVIS10/17/2023, 8:04 AM
Ignat Beresnev10/17/2023, 8:52 AM
CLOVIS10/17/2023, 9:22 AM
should create a link to the corresponding Dokka page) • having everything in a single site When making an application, the API docs (by Dokka) and the user guides (by Writerside) are aimed towards different people. However, most of my projects are libraries (e.g. Pedestal), both are aimed towards the same people: API docs give the details of usage, and user guides teach users how to find what they're searching for, as well as the underlying concepts. For now, I've been (ab)using the Dokka module-level page for this, but it's only really an option in case everything you want to say fits in a single page. I'm considering adopting Writerside because it is meant specifically for this use case. However, it's very important not to split the documentation in two different places—otherwise, users will only read one of them / won't know how to find things in the other one.