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

🧹 [v3 Maintenance]: Update docs to reflect fiber.Ctx struct to interface change #2879

Closed
3 tasks done
grivera64 opened this issue Feb 24, 2024 · 1 comment · Fixed by #2880
Closed
3 tasks done

Comments

@grivera64
Copy link
Member

grivera64 commented Feb 24, 2024

Maintenance Task Description

As v3 introduces a new interface for fiber.Ctx in preference over the current struct *fiber.Ctx in v2, the documentation should also reflect this change. Currently, some v3 docs still refer to *fiber.Ctx.

For example:

This would involve replacing all uses of the *fiber.Ctx struct to instead use the fiber.Ctx interface in the /docs/ folder.

Impact on the Project

This update will help people in the v2 -> v3 migration process when the full release is ready. This also helps avoid confusion for early testers who are using the docs as a reference point.

There's a potential risk that we could be doing this too early, as there may be more complicated changes besides *fiber.Ctx -> fiber.Ctx in certain v3 components of Fiber. This could cause requiring double the work, when all of the changes can be made at once in a single PR.

Additional Context (optional)

This serves as a smaller issue to split the progress of the following larger issues' goals:

#2712
#2713

Checklist:

  • I have confirmed that this maintenance task is currently not being addressed.
  • I understand that this task will be evaluated by the maintainers and prioritized accordingly.
  • I am available to provide further information if needed.
grivera64 added a commit to grivera64/fiber that referenced this issue Feb 24, 2024
…ace change

Summary:
- Update `Static.Next()` in `/docs/api/app.md` to use the `Ctx` interface
- Update `/docs/api/ctx.md` to use the `Ctx` interface

Related Issues:
gofiber#2879
grivera64 added a commit to grivera64/fiber that referenced this issue Feb 28, 2024
ReneWerner87 pushed a commit that referenced this issue Mar 4, 2024
…ace change (#2880)

* 🧹 [v3 Maintenance]: Update docs to reflect fiber.Ctx struct to interface change

Summary:
- Update `Static.Next()` in `/docs/api/app.md` to use the `Ctx` interface
- Update `/docs/api/ctx.md` to use the `Ctx` interface

Related Issues:
#2879

* 🧹 [v3 Maintenance]: Update Ctx struct description to interface

Related Issues:
#2879
@gaby
Copy link
Member

gaby commented Mar 4, 2024

Fxied via #2880

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

Successfully merging a pull request may close this issue.

3 participants