A quick easy fix is to restructure the current documentation according to the suggestions of Paul: https://github.com/apache/incubator-wayang/issues/613 Our guides are somehow hidden here: https://github.com/apache/incubator-wayang/tree/main/guides
Javadoc generation is now done at each release. See last step here: https://wayang.apache.org/docs/community/release but if we can include the javadoc in CI, it would also be better. Best -- Zoi On 2025/12/08 13:12:40 Alexander Alten wrote: > Hi all, > > I’d like to kick off a discussion on strengthening our user documentation. > The current Javadoc set is valuable and usable for API reference, but it does > not cover installation, workflows, tuning, or release guidance. > > I propose we add tutorials and quick starts, concept guides, how-to > documents, and structured release notes to cover those gaps. To keep > everything maintainable, we can reuse information in the codebase: enforce > Javadoc generation in CI, auto-extract configuration properties and operator > registries into Markdown for the website, reuse runnable examples as > documentation snippets, and hook a doc-generation step into the site build so > it stays current. > > Please share feedback on priorities or other automation ideas we should > evaluate? Happy to help prototype once we agree on scope. > > —Alex > > --- > NovaTechFlow > https://www.novatechflow.com/ > >
