Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Integrate Watermarker API Documentation in Docusaurus #68

Open
mhellmeier opened this issue May 29, 2024 · 0 comments
Open

Integrate Watermarker API Documentation in Docusaurus #68

mhellmeier opened this issue May 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation feature New feature or request

Comments

@mhellmeier
Copy link
Member

🚀 Feature Request

Current Problem

Currently, dokkaHtml is used to create autogenerated documentation based on the KDoc comments in the source code (see GitHub workflow). Since Docusaurus is used as the single point of truth for documentation, everything should be located on one page instead of two pages.

Proposed Solution

Integrate the autogenerated API documentation inside the Docusaurus instance.

Additional Context

See Kotlin/dokka#1616 for some details and problems regarding Dokka and Docusaurus.
@mhellmeier mhellmeier added documentation Improvements or additions to documentation feature New feature or request labels May 29, 2024
@mhellmeier mhellmeier mentioned this issue May 29, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mhellmeier