-
Notifications
You must be signed in to change notification settings - Fork 2
Use dokka v2 to generate html vs markdown documentation. #253
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.
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
Conversation
There was a problem hiding this 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.
|
@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. |
|
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. |
lyleschemmerling
left a comment
There was a problem hiding this 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
…ub-directories to test new documentation is GitHub Pages.
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice
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.