Improve Guided Tour documentation

[obuisard]

PR Type

Documentation

---

Description

• Added missing title to creating tours documentation

• Enhanced tour removal guidance with safer SQL approach

• Improved documentation structure and clarity

---

Diagram Walkthrough

flowchart LR
  A["Documentation Files"] --> B["Add Missing Title"]
  A --> C["Enhance SQL Guidance"]
  B --> D["Better Structure"]
  C --> E["Safer Tour Removal"]

Loading

File Walkthrough

Relevant files

Documentation

creating-tours.md Add missing page title                                                                      docs/general-concepts/guided-tours/creating-tours.md Added missing page title "Creating and launching tours" +2/-0      create-whatsnewtour.md Improve tour removal SQL guidance                                                docs/general-concepts/guided-tours/create-whatsnewtour.md Added note recommending safer SQL approach using IN instead of LIKE Provided specific example with tour names for better guidance +7/-0

---

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Wording Clarity The note suggests replacing LIKE with IN but does not show the full SQL example or clarify that the column and operator change occurs in the WHERE clause; consider providing a complete snippet to avoid ambiguity. Note that a better approach, to ensure none of the user's Guided Tours is removed by mistake, is to replace the LIKE with an IN, naming each tour specifically. For instance, IN ('joomla-whatsnew-5.2', 'joomla-whatsnew-5.3', 'joomla-whatsnew-5.4')

[qodo-merge-pro]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	✅ Provide full, safe SQL example Suggestion Impact: The commit replaced the bare IN fragment with a full SQL statement block (adding ```sql and a complete SELECT using IN), addressing the request to provide a complete SQL example. It did not include the exact/case-sensitive or DELETE/UPDATE aspects, but the intent to provide a full statement was implemented. code diff: -For instance, +For instance, in MySQL, -``` -IN ('joomla-whatsnew-5.2', 'joomla-whatsnew-5.3', 'joomla-whatsnew-5.4') +```sql +SELECT `id` FROM `#__guidedtours` WHERE `uid` IN ('joomla-whatsnew-5.2', 'joomla-whatsnew-5.3', 'joomla-whatsnew-5.4') </details> ___ **Clarify that the <code>IN</code> clause must be used within a full SQL statement and that <br>names should be exact and case-sensitive. Provide a concrete example <br>DELETE/UPDATE statement to avoid ambiguity and accidental data loss.** [docs/general-concepts/guided-tours/create-whatsnewtour.md [130-135]](https://github.com/joomla/Manual/pull/495/files#diff-ad8f02049d495525f5380a523cba89992e92511c25f7ce89b18f1047455baaeaR130-R135) ```diff -Note that a better approach, to ensure none of the user's Guided Tours is removed by mistake, is to replace the LIKE with an IN, naming each tour specifically. -For instance, +Note that a better approach, to ensure none of the user's Guided Tours is removed by mistake, is to replace the LIKE with an IN, naming each tour specifically (exact, case-sensitive names). +For instance, use a full SQL statement: -``` -IN ('joomla-whatsnew-5.2', 'joomla-whatsnew-5.3', 'joomla-whatsnew-5.4') +```sql +-- Example: disable autostart for specific What's New tours +UPDATE #__guidedtours +SET autostart = 0 +WHERE name IN ('joomla-whatsnew-5.2', 'joomla-whatsnew-5.3', 'joomla-whatsnew-5.4'); `[Suggestion processed]` <details><summary>Suggestion importance[1-10]: 7</summary> __ Why: The suggestion correctly identifies that the PR provides an incomplete SQL fragment and proposes a full, safer SQL statement, which significantly improves clarity and reduces the risk of user error. </details></details></td><td align=center>Medium </td></tr> <tr><td align="center" colspan="2"> - [ ] Update <!-- /improve_multi --more_suggestions=true --> </td><td></td></tr></tbody></table>