Skip to content

Conversation

@mrudatsprint
Copy link
Contributor

@mrudatsprint mrudatsprint commented Nov 26, 2025

Use dokka v2 to generate html vs markdown documentation.

Issue

GitHub Pages will be used to deploy:

Update the FusionAuth Site to reference the new documentation. The PR for the site.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR upgrades the documentation generation from Dokka markdown to HTML format using Dokka v2. The change enables more feature-rich documentation with enhanced navigation and styling, which will be deployed via GitHub Pages.

  • Migrated from Dokka GFM (markdown) to Dokka HTML format for richer documentation
  • Updated documentation generation command and output location
  • Modified documentation links to point to GitHub Pages instead of repository markdown files

Reviewed changes

Copilot reviewed 105 out of 344 changed files in this pull request and generated no comments.

Show a summary per file
File Description
library/build.gradle.kts Removed dokkaGfm task configuration
gradle.properties Enabled Dokka v2 plugin mode
README.md Updated documentation link to GitHub Pages URL
CONTRIBUTING.md Updated documentation generation command from dokkaGfm to dokkaGenerate
library/docs/**/*.html Generated HTML documentation files (multiple new files)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mooreds
Copy link
Contributor

mooreds commented Nov 30, 2025

@mrudatsprint don't forget to update the SDK docs in the main doc site if possible. If nothing else, a link to the generated docs should be added (in consultation with Nathan). https://fusionauth.io/docs/sdks/android-sdk

@mrudatsprint
Copy link
Contributor Author

@mrudatsprint don't forget to update the SDK docs in the main doc site if possible. If nothing else, a link to the generated docs should be added (in consultation with Nathan). https://fusionauth.io/docs/sdks/android-sdk

Thank you for the reminder and I've created a PR that I'll be sending out for review.

@lyleschemmerling
Copy link
Contributor

One markdown file is okay to serve out of your repo, but a full site including all of the assets is a bad idea, particularly for generated code. We should be able to serve that site out of a Github Pages page without needing to check it in. I can help you with what that might look like if you need it, but that would be a lot cleaner than checking in all of those files.

Copy link
Contributor

@lyleschemmerling lyleschemmerling left a comment

Choose a reason for hiding this comment

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

pages, if we can

@mrudatsprint mrudatsprint requested review from a team as code owners December 1, 2025 21:47
@mrudatsprint
Copy link
Contributor Author

One markdown file is okay to serve out of your repo, but a full site including all of the assets is a bad idea, particularly for generated code. We should be able to serve that site out of a Github Pages page without needing to check it in. I can help you with what that might look like if you need it, but that would be a lot cleaner than checking in all of those files.

The site is now being dynamically generated in github workflow documentation.yml which determines a deployment path so this PR will be deployed to and when merged into main deployed to

@lyleschemmerling lyleschemmerling self-requested a review December 4, 2025 15:52
Copy link
Contributor

@lyleschemmerling lyleschemmerling left a comment

Choose a reason for hiding this comment

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

nice

@mrudatsprint mrudatsprint merged commit 2e51d0c into main Dec 4, 2025
21 of 23 checks passed
@mrudatsprint mrudatsprint deleted the miker/org.jetbrains.dokka-dropped-support branch December 4, 2025 16:15
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.

4 participants