docs: add --skip-workflows flag documentation for kbc init command

[Matovidlo]

Jira issue(s): PSGO-1085

Document the --skip-workflows flag for the kbc init command across multiple sections of the CLI documentation to support automation use cases.

Changes:

• Command Reference: Added --skip-workflows flag documentation to /cli/commands/sync/init/ with description "Skip the interactive GitHub workflow setup"
• GitHub Integration: Enhanced introduction to mention the flag for automated CI/CD scenarios where interactive prompts should be avoided
• DevOps Use Cases: Updated automation examples to include --skip-workflows alongside --allow-target-env for non-interactive initialization
• CLI Overview: Enhanced automation bullet point to specifically mention the flag for avoiding interactive prompts in automated environments

---

Additional Notes:

This addresses PR feedback requesting broader documentation of the --skip-workflows flag beyond just the command reference. The flag is particularly valuable for:

• CI/CD pipelines that need to run kbc init without human interaction
• Docker containers or automated scripts initializing projects programmatically
• DevOps workflows setting up multiple projects automatically

Review Focus Areas:

• Verify the flag exists and behaves as documented (implementation found in devin/PSGO-1085-1758283952 branch of keboola-as-code)
• Confirm that --allow-target-env --skip-workflows is a valid flag combination as shown in the DevOps examples
• Check that the automation scenarios described are realistic and helpful for users

Link to Devin run: https://app.devin.ai/sessions/284a918ddf04416ab475d38fcd206a2d
Requested by: Martin Vasko (@Matovidlo)

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring

[Matovidlo]

I think there are other occurences except of documentation of command. Try to write about this new flag there mentioning that it should be used to have automate CI/CD workflows without interactions

[Copilot]

Pull Request Overview

This PR adds comprehensive documentation for the --skip-workflows flag for the kbc init command to support automation use cases where interactive prompts should be avoided.

• Added --skip-workflows flag documentation to the command reference
• Enhanced GitHub integration and DevOps sections to mention the flag for CI/CD scenarios
• Updated automation examples to include both --allow-target-env and --skip-workflows flags

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
cli/index.md	Enhanced automation bullet point to mention --skip-workflows flag for avoiding interactive prompts
cli/github-integration/index.md	Added note about using --skip-workflows flag for automated CI/CD scenarios
cli/devops-use-cases/index.md	Updated initialization examples to include --skip-workflows alongside --allow-target-env
cli/commands/sync/init/index.md	Added formal documentation for the --skip-workflows flag in command reference

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}