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(versioning): adding dokka versioning plugin #335

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

DariusIMP
Copy link
Member

Overview

This PR introduces the dokka versioning plugin (see https://kotlin.github.io/dokka/1.4.30/user_guide/versioning/versioning/).

This allows to display a dropdown menu on the documentation site with the old versions:

Screenshot 2025-01-03 at 16 58 54

How it works

The plugin is configured in such a way that in order to be able to build the documentation with versioning, we need to

  1. Have the latest docs version under /docs
  2. Have the older documentation versions under /docs/older.

When those requirements are met, then when runing

gradle dokkaHtml

an html site with the documentation is generated which contains the older versions.

Copy link

github-actions bot commented Jan 3, 2025

PR missing one of the required labels: {'internal', 'new feature', 'breaking-change', 'documentation', 'enhancement', 'dependencies', 'bug'}

@DariusIMP DariusIMP added documentation Improvements or additions to documentation release Part of the next release internal Changes not included in the changelog labels Jan 3, 2025
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 internal Changes not included in the changelog release Part of the next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant