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

Migrate website to Docusaurus #595

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Conversation

matt-ramotar
Copy link
Collaborator

Closes #562

Description

Migrating our docs to Docusaurus and moving its source code to our main branch under the website package. Docusaurus is powered by MDX and React and supports versioning and search via Algolia. My primary motivation is increasing maintainability. Opening up the possibility of customizing our docs with React is a secondary motivation.

mramotar added 11 commits March 16, 2024 19:15
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
Signed-off-by: mramotar <mramotar@dropbox.com>
// Workaround for https://youtrack.jetbrains.com/issue/KT-63014
plugins.withType<NodeJsRootPlugin> {
extensions.configure(NodeJsRootExtension::class) {
nodeVersion = "21.0.0-v8-canary20231019bd785be450"
Copy link
Contributor

Choose a reason for hiding this comment

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

do we want to throw version in toml?

}
}

tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets.configureEach {
reportUndocumented.set(false)
skipDeprecated.set(true)
jdkVersion.set(8)
jdkVersion.set(11)
Copy link
Contributor

Choose a reason for hiding this comment

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

why 11?

/**
* Used for strongly-referenced keys.
*
* The code below is exactly the same for each entry type.
Copy link
Contributor

Choose a reason for hiding this comment

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

im confused what this comment means

override fun getOrPut(
key: K,
valueProducer: () -> O,
): O {
Copy link
Contributor

Choose a reason for hiding this comment

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

not crazy about this one, feels less descriptive, maybe we can just suppress the rule?

@@ -16,10 +16,6 @@ plugins {
id("kotlinx-atomicfu")
}

rootProject.plugins.withType<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin> {
Copy link
Contributor

Choose a reason for hiding this comment

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

intentional removal?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 Triage
Development

Successfully merging this pull request may close these issues.

[Documentation] Update Store documentation
2 participants