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

Improve Routing docs #98

Merged
merged 6 commits into from
Feb 8, 2022
Merged

Improve Routing docs #98

merged 6 commits into from
Feb 8, 2022

Conversation

afilina
Copy link
Contributor

@afilina afilina commented Feb 4, 2022

Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no

Description

Cleaning up the Laminas MVC routing documentation:

  • Clean up the intro paragraphs.
  • Give a simple but full config example using a Literal type.
  • Explain in which file to put the routing config, since this is not obvious from any of the other pages.
  • Make a bullet-point of the route types with a one-line explanation for each, then link to the appropriate heading in the laminas-router/routing docs. The idea is to avoid duplicating all the content from laminas-router in laminas-mvc.
  • Note the version in which certain route types were deprecated and removed, in case someone lands here while upgrading an older application.
  • Remove reference to laminas-console, since that package is no longer maintained.
  • Simplify the note regarding last-in-first-out.

@afilina afilina changed the title Routing Improve Routing docs Feb 4, 2022
docs/book/routing.md Outdated Show resolved Hide resolved
Signed-off-by: Anna Filina <[email protected]>

Co-authored-by: Frank Brückner <[email protected]>
@Ocramius Ocramius requested a review from froschdesign February 7, 2022 17:28
@Ocramius Ocramius added this to the 3.3.2 milestone Feb 7, 2022
@Ocramius Ocramius self-assigned this Feb 8, 2022
Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

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

Nice cleanup, thanks @afilina!

@Ocramius Ocramius merged commit 16bb3bc into laminas:3.3.x Feb 8, 2022
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.

3 participants