Additional documentation for tours: how to create the What's New tour and prepare it for a Joomla release

[obuisard]

PR Type

Documentation

---

Description

• Adds comprehensive guide for creating "What's New" tours in Joomla.

• Introduces a new index page for the Guided Tours documentation section.

• Updates and clarifies general tour creation instructions.

---

Changes walkthrough 📝

Relevant files

Documentation

create-whatsnewtour.md Add comprehensive guide for creating "What's New" tours    docs/general-concepts/guided-tours/create-whatsnewtour.md Adds a new, step-by-step guide for creating "What's New" tours. Covers tour creation, toolkit usage, export, PR process, and testing. Provides SQL and language file instructions for both MySQL and PostgreSQL. Includes developer notes and example content for clarity. +186/-0  index.md Add index page for Guided Tours documentation section        docs/general-concepts/guided-tours/index.md Introduces a new index page for the Guided Tours documentation section. Sets up a landing page with a brief description and title. +4/-0      creating-tours.md Update and clarify general guided tour creation instructions docs/general-concepts/guided-tours/creating-tours.md Updates tour creation instructions to remove Joomla 5-specific phrasing. Clarifies identifier and auto start feature descriptions. Improves general readability and accuracy of the documentation. +2/-5

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

[HLeithner]

Some annotations.

• Every file needs a h1 headline underlined with =
• Please don't use "timebased or version based" information, things like "Since version 4.3...." just write the docs that the feature exists. Reason is that in 2 years nobody is interested in when the feature has been added.
• if you use code blocks please add the language and may add a headline for it, example ```sql title="uninstall previous tours"
• if you like to have the mysql and postgresql more compact you can use tabs

[HLeithner]

I updated the syntax a bit and versions

[HLeithner]

@obuisard is this ready to merge?

[qodo-code-review[bot]]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Inconsistent Formatting The document uses inconsistent formatting for placeholders. In some places it uses X.Y and in others X_Y. This could confuse readers about the correct format to use when implementing the instructions. Replace X and Y with the major and minor version numbers. For instance, X_Y is 5_3 if you create a PR for the what's new tour for version 5.3. ::: Minimal Content The index page contains very minimal information about Guided Tours. Consider expanding this with a more comprehensive overview of what tours are, their benefits, and links to the other tour-related documentation pages. --- title: Guided Tours --- This section describes the concept of Tours.

[qodo-code-review[bot]]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Fix nested code blocks The SQL code blocks are missing proper markdown syntax for code fences within Tabs components. The nested code blocks need to be properly escaped to render correctly in the documentation. docs/general-concepts/guided-tours/create-whatsnewtour.md [107-128] <Tabs> <TabItem value="mysql" label="MySQL"> + ```sql -- uninstall previous tours DELETE FROM `#__guidedtour_steps` WHERE `tour_id` IN (SELECT `id` FROM `#__guidedtours` WHERE `uid` LIKE 'joomla-whatsnew-%'); DELETE FROM `#__guidedtours` WHERE `uid` LIKE 'joomla-whatsnew-%'; + ```sql -- uninstall previous tours DELETE FROM "#__guidedtour_steps" WHERE "tour_id" IN (SELECT "id" FROM "#__guidedtours" WHERE "uid" LIKE 'joomla-whatsnew-%'); DELETE FROM "#__guidedtours" WHERE "uid" LIKE 'joomla-whatsnew-%'; + </TabItem> </Tabs> [ ] Apply this suggestion Suggestion importance[1-10]: 3 __ Why: The suggestion correctly identifies that nested code blocks within Tabs components often require surrounding blank lines for proper rendering in Markdown parsers like Docusaurus. This is a minor formatting fix to improve documentation appearance.	Low
	Fix code block formatting Similar to the previous issue, the nested SQL code blocks need proper spacing to render correctly. Additionally, ensure consistent spacing between tab items for better readability. docs/general-concepts/guided-tours/create-whatsnewtour.md [132-145] <Tabs> <TabItem value="mysql" label="MySQL"> + ```sql -- disable autostart for the previous tour UPDATE `#__guidedtours` SET `autostart` = 0 WHERE `uid` = 'joomla-whatsnew-X-YY'; -</TabItem> + +</TabItem> <TabItem value="pgsql" label="PostgreSQL"> + -- disable autostart for the previous tour UPDATE "#__guidedtours" SET "autostart" = 0 WHERE "uid" = 'joomla-whatsnew-X-YY'; ``` [ ] Apply this suggestion Suggestion importance[1-10]: 3 __ Why: Similar to the previous suggestion, this correctly points out the need for blank lines around nested code blocks within Tabs for proper rendering. It also implicitly corrects inconsistent spacing. This is a minor formatting improvement for documentation readability.	Low
[ ] More

[obuisard]

@obuisard is this ready to merge?

Yes thanks Harald @HLeithner