feat: generate go-links for releases #249
Conversation
WalkthroughThis pull request reformats the Changes
Possibly related PRs
Suggested Reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docusaurus.config.js (2)
134-415: Footer Links and Go-Link Reformatting:
Multiple footer link entries—including documentation links, community links, and especially the go-link redirects—have been reformatted into single-line objects. This restructuring reduces visual clutter and promotes consistency. Please double-check that all URLs and labels are still accurate and align with the project’s navigation standards.
440-457: Enhancements forcreateRedirectsFunction:
The automatic redirect logic for release notes appears sound. However, consider simplifying the version check by using optional chaining—for example:- if (versionMatch && versionMatch[1]) { + if (versionMatch?.[1]) {Additionally, the
console.logstatements used for debugging (lines 443 and 451) might be removed or conditionally enabled in production to avoid unnecessary console output.🧰 Tools
🪛 Biome (1.9.4)
[error] 448-448: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docusaurus.config.js(14 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
docusaurus.config.js
[error] 448-448: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (6)
docusaurus.config.js (6)
70-71: Consolidated Theme and Gtag Configurations:
Thethemeandgtagobjects have been reformatted into a single-line style. This concise formatting improves visual clarity without affecting functionality.
87-87: Flattened Docs Sidebar Configuration:
The sidebar configuration now appears as a compact one-liner. This change reduces visual clutter while preserving the intended behavior.
112-112: Inline Navbar Logo Style Update:
The logo’s style property has been consolidated into a single line. Please verify that the width specification (“30px”) meets the design requirements.
117-118: Navbar ‘More’ Dropdown Links Formatting:
The external links for “Unraid Home” and “Forums” have been reformatted into single-line objects. This simplifies the configuration and maintains consistency.
124-124: Locale Dropdown Addition in Navbar:
The addition of{ type: "localeDropdown", position: "right" }clearly exposes the multilingual selection option in the navbar. The concise format is appropriate.
127-127: Condensed Table of Contents Settings:
The table of contents configuration has been flattened into a single line. This streamlined presentation improves readability while retaining functionality.
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
| @@ -550,6 +437,24 @@ const config = { | |||
| from: "/go/tailscale-docker", | |||
| }, | |||
| ], | |||
| createRedirects(existingPath) { | |||
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docusaurus.config.js (1)
440-455: Great addition of automatic go-links for release notes!The new
createRedirectsfunction effectively creates automatic redirects for release notes based on version numbers, which aligns perfectly with the PR objective of generating go-links for releases.One small improvement suggestion:
Consider using optional chaining on line 447 for a more concise check:
- if (versionMatch && versionMatch[1]) { + if (versionMatch?.[1]) {🧰 Tools
🪛 Biome (1.9.4)
[error] 447-447: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)
📒 Files selected for processing (2)
.vscode/extensions.json(1 hunks)docusaurus.config.js(14 hunks)
✅ Files skipped from review due to trivial changes (1)
- .vscode/extensions.json
🧰 Additional context used
🪛 Biome (1.9.4)
docusaurus.config.js
[error] 447-447: Change to an optional chain.
Unsafe fix: Change to an optional chain.
(lint/complexity/useOptionalChain)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (1)
docusaurus.config.js (1)
70-71: Code formatting improvements look good!The consolidated single-line formatting of configuration objects makes the code more compact while maintaining readability. This consistent approach across theme, gtag, docs, navbar, footer, and other sections improves the overall file structure.
Also applies to: 87-87, 112-112, 117-118, 124-124, 127-127, 134-134, 144-145, 151-154, 223-223, 250-251, 290-290, 304-304, 317-320, 325-325, 330-330, 355-355, 360-361, 374-374, 387-387, 404-405, 410-410
Before Submitting This PR, Please Ensure You Have Completed The Following:
Summary by CodeRabbit