Auto-start and events information

[obuisard]

PR Type

Documentation

---

Description

• Added documentation for the auto-start feature in guided tours, explaining how tours can be set to run automatically and user options for hiding or delaying tours.
• Introduced a new section on event dispatchers, detailing the events triggered when a user cancels, opts-out, or completes a tour.
• Listed specific events (onBeforeTourRunSaveState, onTourRunSaveState, onAfterTourRunSaveState) and their purposes.

---

Changes walkthrough 📝

	Relevant files
Documentation	guided-tours.md Document auto-start and event dispatchers for guided tours docs/general-concepts/guided-tours.md Added section on auto-start functionality for guided tours. Introduced event dispatchers for tour actions. Detailed specific events triggered by user actions on tours. +16/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-pro]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Improve clarity and conciseness in the description of event dispatchers Consider rephrasing the description of the event dispatchers to make it clearer and more concise. The current description might confuse readers with its repetitive mention of "saving the auto-start tour user state". Simplifying the language and focusing on the unique aspects of each event can improve readability and understanding. docs/general-concepts/guided-tours.md [86-89] -Those events are: -- onBeforeTourRunSaveState: triggered before saving the auto-start tour user state and recording user action logs -- onTourRunSaveState: triggered before saving the auto-start tour user state, used to record user actions into the logs -- onAfterTourRunSaveState: triggered after saving the auto-start tour user state and recording user action logs +These events are triggered at different stages: +- onBeforeTourRunSaveState: Before any data is saved or actions are logged. +- onTourRunSaveState: Just before data saving, specifically for logging actions. +- onAfterTourRunSaveState: After all data has been saved and actions logged. Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion improves readability and understanding by removing repetitive language and focusing on the unique aspects of each event. This enhances the documentation's clarity, which is crucial for developers who need to understand and use these events.	8