Skip to content

Dokka Documentation#2594

Open
jimlyas wants to merge 6 commits intorecloudstream:masterfrom
jimlyas:chore/gradle
Open

Dokka Documentation#2594
jimlyas wants to merge 6 commits intorecloudstream:masterfrom
jimlyas:chore/gradle

Conversation

@jimlyas
Copy link
Copy Markdown
Contributor

@jimlyas jimlyas commented Apr 1, 2026

This PR include

Dokka Documentation Generation

Removing docs module, Now Dokka documentation can be generated directly from the root project.

# Before
./gradlew :docs:dokkaGeneratePublicationHtml

# After
./gradlew dokkaGeneratePublicationHtml

The generated documentation:

Module ScreenShoot
Root All Module
App App Module
Library Library Module

There's some package documentation named packages.md for app and library modules generated by AI.

@jimlyas jimlyas marked this pull request as draft April 1, 2026 06:57
@jimlyas jimlyas marked this pull request as ready for review April 1, 2026 07:59
@fire-light42
Copy link
Copy Markdown
Collaborator

Great contributions!

However please keep these two changes as separate pull requests to make it easier to review and merge accordingly. It also helps with future debugging and reverting.

@jimlyas jimlyas changed the title Dokka Documentation and Gradle Dependency Verification Dokka Documentation Apr 2, 2026
@Luna712
Copy link
Copy Markdown
Contributor

Luna712 commented Apr 2, 2026

Note to @fire-light42 before merging this I would prefer (though definitely up to you) this wait until after AGP 9, as I have spent months testing and working on AGP 9 changes including Dokka support and other stuff, I really dont want to have to rebegin testing compatibility with the merged projects and removal of docs which does change the functionality a bit. Again up to you though.

Overall this is a nice contribution though and this is not to say otherwise.

@fire-light42
Copy link
Copy Markdown
Collaborator

Of course, those who have made pull requests should not worry about having to adapt to new changes due to a slow review process.

# Package com.lagradost.cloudstream3.ui.settings.testing

Testing utilities:
- TestFragment - Testing UI
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am unsure about AI generated documentation for these things.

It may look good at a glance, but it might not be very good long term. First of all it creates a maintenance task, which requires maintainers and contributors to keep this updated every time something is changed.

Secondly, it is not very helpful. In this example we have "Testing UI", what does it mean? It tells nothing more than the file name currently.

I think if we want more documentation about what files do we need to introduce a code standard wherein people use doc comments more and in an organized manner A workflow could then automatically generate appropriate documentation. This would make intuitive sense for contributors and be useful even if people only look at the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants