8000 Add more go links by ljm42 · Pull Request #291 · unraid/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add more go links #291

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

Merged
merged 1 commit into from
Jun 24, 2025
Merged

Add more go links #291

merged 1 commit into from
Jun 24, 2025

Conversation

ljm42
Copy link
Member
@ljm42 ljm42 commented Jun 24, 2025

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • New Features
    • Added two new short "go" links that redirect to specific sections of the documentation for multiple pools and data encryption.

Copy link
Contributor
coderabbitai bot commented Jun 24, 2025
📝 Walkthrough

Walkthrough

Two new client-side redirect mappings were added to the Docusaurus configuration. These map the short paths "/go/multiple-pools" and "/go/data-encryption" to their respective documentation sections, expanding the set of available "go" links. No other logic or configuration changes were made.

Changes

File(s) Change Summary
docusaurus.config.js Added two new redirect mappings for "/go/multiple-pools" and "/go/data-encryption" to documentation

Sequence Diagram(s)

sequenceDiagram
    User->>Docusaurus: Navigates to /go/multiple-pools or /go/data-encryption
    Docusaurus->>Client Redirects Plugin: Checks redirect mappings
    Client Redirects Plugin-->>User: Redirects to corresponding documentation section
Loading

Possibly related PRs

Poem

Hopping down the docs with glee,
Two new "go" links set free!
Multiple pools and encryption's might,
Now just a hop and you're in sight.
With every redirect, the docs grow tall—
A rabbit's guide to help you all!
🥕✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docusaurus.config.js (1)

472-475: Nit: keep the security go-links alphabetically ordered for easier maintenance

The newly added data-encryption entry sits after webgui-ssl and before tailscale; alphabetically it would belong before vpn.
Re-ordering isn’t functionally required, but helps future contributors locate links quickly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 16a3579 and 2e530f1.

📒 Files selected for processing (1)
  • docusaurus.config.js (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: AWS Amplify Console Web Preview
  • GitHub Check: build
🔇 Additional comments (1)
docusaurus.config.js (1)

313-316: New “multiple-pools” go-link looks good

Mapping is syntactically correct, follows the existing pattern for anchor redirects, and is inserted in the appropriate storage-management block.

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-291.d1o5s833kbd339.amplifyapp.com

@ljm42 ljm42 merged commit d5ef01e into main Jun 24, 2025
3 checks passed
@ljm42 ljm42 deleted the add-more-go-links-2 branch June 24, 2025 00:42
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
0