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

Modern Dokka #505

Merged
merged 3 commits into from
Dec 5, 2023
Merged

Modern Dokka #505

merged 3 commits into from
Dec 5, 2023

Conversation

FWDekker
Copy link
Owner

@FWDekker FWDekker commented Dec 5, 2023

Modernises the Dokka setup:

  • Adds a version dropdown menu to switch between versions.
  • Adds a workflow that will update the GitHub pages automatically when a new GitHub release is created.
  • Adds an icon and favicon to the documentation.
  • Fixes a bug where the version number is displayed multiple times in the header.
  • Shows documentation for all functions, not just public functions. (I think I've "fixed" this bug multiple times over the years...)

In the process, I also discovered and reported Kotlin/dokka#3398.

Also, rewrites the security policy. The most relevant change here is that vulnerabilities should preferably be reported through GitHub's reporting system instead of mailing it to a private email address. (Though I will still see emails to the old address.)

Also bumps a few dependencies.

@FWDekker FWDekker added tooling Configuration of and updates to analysis and build tools documentation Improvements or additions to documentation labels Dec 5, 2023
@FWDekker FWDekker self-assigned this Dec 5, 2023
Copy link

codecov bot commented Dec 5, 2023

Codecov Report

Merging #505 (a7a7756) into main (dd6ca0e) will increase coverage by 0.04%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #505      +/-   ##
==========================================
+ Coverage   85.04%   85.09%   +0.04%     
==========================================
  Files          52       51       -1     
  Lines        1993     1992       -1     
  Branches      335      335              
==========================================
  Hits         1695     1695              
+ Misses        235      234       -1     
  Partials       63       63              

@FWDekker FWDekker merged commit 6927340 into main Dec 5, 2023
8 checks passed
@FWDekker FWDekker deleted the modern-dokka branch December 5, 2023 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tooling Configuration of and updates to analysis and build tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant