+1

I think those different orientations make sense

Onboarding new dev - how to get started ?
Technical Reference for all dev - how does it work?
Functional documentation - what’s does it do?
Release maintenance - how do we release




Sent from Gmail Mobile

On Tue, Sep 1, 2026 at 1:22 PM Aleksandar Vidakovic <
[email protected]> wrote:

> ... in the end: probably the content is not only one book/documentation...
> at the moment this is more like a kitchen sink... remember that we started
> out with 3 pages taken from the old handwritten HTML documentation...
>
> I can easily see to split up the content e.g. in separate "books":
>
>    - developer onboarding
>    - detailed technical documentation with architecture diagrams etc.
>    - business/functional documentation
>    - maintainer documentation (including release process)
>
> ... no claim that this is how it should be split up, but one way or
> another we can split things up.
>
> On Tue, Sep 1, 2026 at 9:46 PM Adam Monsen <[email protected]> wrote:
>
>> Got any other feedback re: generated-package-overview.adoc and
>> cross-feature-boundary-violations.adoc? I have strong opinions about
>> those.
>>
>>
>> Aleks wrote:
>>
>>> How about transforming into multiple pages instead one huge document?
>>
>> Not an option for PDF (or is it?).
>>
>> For HTML I like the simplicity of a single large manual/document, but I
>> guess if we worked out an easy/fast way to search a split-up manual, sure,
>> that could work. There are of course many ways to accomplish splitting and
>> searching, but so far it hasn't been necessary and I'd prefer to avoid it.
>>
>

Reply via email to