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.

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

docs: rework dokka generation #104

Merged
merged 8 commits into from
Oct 31, 2024
Merged

docs: rework dokka generation #104

merged 8 commits into from
Oct 31, 2024

Conversation

utybo
Copy link
Owner

@utybo utybo commented Oct 20, 2024

Dokka isn't great, and documentation display is broken due to how fragile the hack around URLs here. It's probable that I was just doing something stupid, but in the mean time let's switch to Dokkatoo to get some nice(r) docs going on.

Edit: for future reference, I also had to disable "pretty URLs" from Netlify's config because it rewrites /index.html to / and that breaks Dokka/Dokkatoo

Edit2: As a bonus, add access to the Ktor Application instance in KtorApplication and add a proper regression test on OpenAPI stuff

Copy link

github-actions bot commented Oct 20, 2024

@github-actions github-actions bot temporarily deployed to pull request October 20, 2024 18:21 Inactive
@github-actions github-actions bot temporarily deployed to pull request October 20, 2024 19:04 Inactive
Copy link

codecov bot commented Oct 20, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 89.64%. Comparing base (fa42840) to head (8789461).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
.../zoroark/tegral/web/controllers/KtorApplication.kt 33.33% 0 Missing and 2 partials ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main     #104      +/-   ##
============================================
+ Coverage     89.31%   89.64%   +0.32%     
- Complexity      721      727       +6     
============================================
  Files           200      202       +2     
  Lines          4485     4568      +83     
  Branches        434      441       +7     
============================================
+ Hits           4006     4095      +89     
+ Misses          320      310      -10     
- Partials        159      163       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@utybo utybo force-pushed the update-dependencies-2024-10 branch from e41b854 to 6137553 Compare October 20, 2024 20:35
Base automatically changed from update-dependencies-2024-10 to main October 20, 2024 20:51
@utybo utybo force-pushed the dokkatoo-migration-2024-10 branch from 94aab67 to f6c3dee Compare October 20, 2024 20:53
@github-actions github-actions bot temporarily deployed to pull request October 20, 2024 20:57 Inactive
@utybo utybo force-pushed the dokkatoo-migration-2024-10 branch from f6c3dee to ffcc45b Compare October 20, 2024 21:04
@github-actions github-actions bot temporarily deployed to pull request October 20, 2024 21:10 Inactive
@github-actions github-actions bot temporarily deployed to pull request October 26, 2024 20:50 Inactive
@github-actions github-actions bot temporarily deployed to pull request October 26, 2024 21:37 Inactive
@utybo utybo marked this pull request as ready for review October 26, 2024 21:47
@github-actions github-actions bot temporarily deployed to pull request October 28, 2024 22:10 Inactive
@github-actions github-actions bot temporarily deployed to pull request October 28, 2024 22:49 Inactive
@github-actions github-actions bot temporarily deployed to pull request October 28, 2024 23:07 Inactive
@utybo utybo merged commit 1307dac into main Oct 31, 2024
8 of 9 checks passed
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.

1 participant