Skip to content

Conversation

@guerzon
Copy link
Contributor

@guerzon guerzon commented Nov 1, 2025

Description

This is a minor change to fix a broken link in the Routing page.

Changes introduced

Fix a broken link in the Routing page.

Type of change

  • Documentation update (changes to documentation)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • [n/a] Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • [n/a] Added or updated unit tests to validate the effectiveness of the changes or new features.
  • [n/a] Ensured that new and existing unit tests pass locally with the changes.
  • [n/a] Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • [n/a] Aimed for optimal performance with minimal allocations in the new code.
  • [n/a] Provided benchmarks for the new code to analyze and improve upon.

@guerzon guerzon requested a review from a team as a code owner November 1, 2025 04:46
@welcome
Copy link

welcome bot commented Nov 1, 2025

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @guerzon, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a minor but important documentation issue by fixing a broken link within the Routing guide. The change ensures that users can correctly navigate to the documentation for the Params function, improving the overall accuracy and usability of the Fiber documentation.

Highlights

  • Documentation Fix: Corrected a broken link in the 'Routing' guide that pointed to an incorrect location for the Params function documentation.
  • Link Update: The old link https://fiber.wiki/context#params has been updated to https://docs.gofiber.io/api/ctx/#params.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 1, 2025

Walkthrough

Updated the Params reference link in the Routing guide from the old fiber.wiki URL to the repository-relative API docs path.

Changes

Cohort / File(s) Summary
Documentation Link Update
docs/guide/routing.md
Replaced Params reference link https://fiber.wiki/context#params with ../api/ctx.md#params in the routing guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Review focus: docs/guide/routing.md link target and relative path correctness.

Possibly related PRs

Suggested labels

📒 Documentation

Suggested reviewers

  • sixcolors
  • efectn

Poem

🐰 A hop, a skip, a link made bright,
Old path replaced with docs in sight,
One tiny change across the hay,
Guides now point the proper way. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed The pull request description follows the required template structure and is mostly complete for this type of change. The author provides a clear description of the fix, appropriately selects "Documentation update" as the type of change, and correctly marks most checklist items as n/a since this is a minor documentation fix with no code changes, tests, or performance considerations required. The "Fixes # (issue)" section is absent, but this is not critical for a straightforward broken link correction. The description adequately communicates what was changed and why, with appropriate documentation of the self-review and updated files. The level of detail is reasonable and proportionate to the scope of the change.
Title Check ✅ Passed The pull request title "📚 docs: fix broken link in the Routing guide" is fully related to the main change in the changeset. The raw summary confirms that the update involved correcting a broken documentation link in docs/guide/routing.md from an external URL to a relative path. The title accurately and specifically captures this primary change. While the emoji (📚) adds stylistic noise that the guidelines recommend avoiding, the textual content clearly communicates the core objective, and a teammate scanning the history would immediately understand that a documentation link was fixed.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request fixes a broken link in the routing guide documentation. The change updates the URL for the Params function to point to the correct location in the current documentation. This is a valuable correction that improves the quality and usability of the documentation. The change is accurate and I have no further comments.

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)
docs/guide/routing.md (1)

88-88: Verify the updated link is accessible and fix linking consistency.

The link update from deprecated fiber.wiki to docs.gofiber.io is correct and accessible. However, this file uses mixed linking patterns: line 88 now uses an absolute URL [Params](https://docs.gofiber.io/api/ctx/#params) while line 344 uses a relative path [Next](../api/ctx.md#next). For maintainability, update line 88 to use the relative link pattern: [Params](../api/ctx.md#params).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ef6de5 and 5e0f319.

📒 Files selected for processing (1)
  • docs/guide/routing.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Review and update the contents of the docs folder if necessary when modifying code

Files:

  • docs/guide/routing.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: ckoch786
Repo: gofiber/fiber PR: 3230
File: docs/whats_new.md:944-951
Timestamp: 2024-12-15T19:56:45.935Z
Learning: Detailed usage examples and explanations for new methods like `RemoveRoute` and `RemoveRouteByName` are documented in `docs/api/app.md`, so it's unnecessary to duplicate them in `docs/whats_new.md`.
📚 Learning: 2024-12-15T19:56:45.935Z
Learnt from: ckoch786
Repo: gofiber/fiber PR: 3230
File: docs/whats_new.md:944-951
Timestamp: 2024-12-15T19:56:45.935Z
Learning: Detailed usage examples and explanations for new methods like `RemoveRoute` and `RemoveRouteByName` are documented in `docs/api/app.md`, so it's unnecessary to duplicate them in `docs/whats_new.md`.

Applied to files:

  • docs/guide/routing.md

@gaby gaby changed the title 📚 Doc: fix broken link in the Routing guide 📚 docs: fix broken link in the Routing guide Nov 1, 2025
@gaby gaby requested a review from ReneWerner87 November 1, 2025 14:21
@ReneWerner87 ReneWerner87 merged commit fd61ec9 into gofiber:main Nov 1, 2025
3 checks passed
@welcome
Copy link

welcome bot commented Nov 1, 2025

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants