Documenting application routing

[Hackwar]

User description

This is the documentation for the application routing in Joomla and for the new tainted flag in the CMS PR joomla/joomla-cms#44455

---

PR Type

Documentation

---

Description

• Added comprehensive documentation on Joomla's application routing, detailing the process of mapping URLs to code and vice versa.
• Explained the concept of search engine friendly (SEF) URLs, including how Joomla converts query parameters into human-readable URLs.
• Provided examples of SEF URLs and described the process of transforming standard URLs into SEF URLs.
• Introduced new error handling mechanisms for URL parsing, including the use of a tainted flag for identifying and correcting malformed URLs.

---

Changes walkthrough 📝

	Relevant files
Documentation	routing.md Comprehensive documentation on Joomla routing and SEF URLs docs/general-concept/routing.md Added detailed explanation of application routing in Joomla. Described the process of parsing and building URLs. Explained search engine friendly (SEF) URLs and their components. Introduced error handling improvements in URL parsing. +33/-2

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[qodo-merge-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 Security concerns URL Parsing Security: The documentation discusses URL parsing and redirection mechanisms but doesn't address potential security implications of URL manipulation or how to prevent malicious URL inputs. This could potentially lead to security issues if implementers don't properly validate and sanitize URLs.

⚡ Recommended focus areas for review Documentation Clarity The explanation of the tainted flag mechanism could be clearer about what specific URL patterns trigger it and what the exact validation rules are Missing Information The documentation should include information about potential performance implications of URL parsing and redirection handling

[qodo-merge-pro]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Typo	Fix inconsistent spelling in example URL path Fix the typo in the URL example path from "lort-wiki" to "lotr-wiki" to maintain consistency with the later reference. docs/general-concept/routing.md [31] -/<span style="color:yellow">lort-wiki</span>/<span style="color:red">cities-in-middleearth</span>/<span style="color:green">minas-tirith</span> +/<span style="color:yellow">lotr-wiki</span>/<span style="color:red">cities-in-middleearth</span>/<span style="color:green">minas-tirith</span> Apply this suggestion Suggestion importance[1-10]: 8 Why: The typo "lort-wiki" vs "lotr-wiki" creates inconsistency with later references and could confuse readers. Fixing this maintains documentation accuracy and prevents potential confusion.	8
Enhancement	Improve URL readability with consistent hyphenation in compound words Use consistent hyphenation in the URL path - change "cities-in-middleearth" to "cities-in-middle-earth" for better readability. docs/general-concept/routing.md [26] -/lotr-wiki/cities-in-middleearth/minas-tirith +/lotr-wiki/cities-in-middle-earth/minas-tirith Apply this suggestion Suggestion importance[1-10]: 5 Why: Adding a hyphen in "middle-earth" improves readability and maintains consistent formatting in URL examples, though the impact is relatively minor as both versions would work in practice.	5

💡 Need additional feedback ? start a PR chat