Add new FAQ

[usama9500]

• Added new FAQs from general and help channel from discord

Summary by CodeRabbit

• New Features

  • Added several new FAQs addressing embedding the BPMN editor, retrieving lane/group information, modifying process instances, generating UUIDs in Python, and mapping input/output for subprocesses.

• Enhancements

  • Expanded existing FAQ answers with detailed guidance and practical examples, particularly for the approval process and external system integration.

• Clarifications

  • Included specific instructions for service task configuration, error handling, and communication in SpiffArena behind a proxy.

• Code Examples

  • Added code snippets to illustrate configurations and usage throughout the FAQ.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in the docs/Support/FAQ.md file involve the addition of new questions and answers, as well as modifications to existing entries. New FAQs cover topics such as embedding the BPMN editor in an iframe and modifying process instances during execution. Additionally, existing entries have been expanded with detailed explanations, clarifications, and code examples to enhance user understanding of SpiffWorkflow and SpiffArena functionalities.

Changes

File

Change Summary

docs/Support/FAQ.md

- Added new FAQs: embedding BPMN editor in an iframe, retrieving lane/group info, modifying process instances, generating UUIDs in Python, mapping input/output for Call Activity subprocesses. - Expanded existing FAQs with more details and examples on approval processes, integration features, configuration, and error handling. - Included code snippets for service tasks and authentication management.

Possibly related PRs

• docker_permission_issue_faq #2083: Updates the FAQ section on "Fixing Resolving Docker Permission Issues When Installing SpiffArena (Linux)," which is also addressed in this PR, indicating a direct connection in content updates related to Docker permissions.

Suggested reviewers

• burnettk

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)

docs/Support/FAQ.md (4)

Line range hint 1-592: Consider reorganizing FAQs into topic-based sections

The FAQs would be more navigable if organized into topic-based sections such as:

• Getting Started
• Installation & Configuration
• Authentication & Security
• Integration & External Systems
• Workflow Design
• Task Management
• Troubleshooting

🧰 Tools

🪛 Markdownlint (0.35.0)

543-543: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

544-544: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

583-591: Add language identifier to code block

Add the Python language identifier to the code block for better syntax highlighting:

-  ```
+  ```python
   import uuid
   unique_id = str(uuid.uuid4())

---

`468-470`: **Remove line number artifacts**

Remove the line numbers ("468~", "469~", "470~") that appear to be artifacts in the text.

---

`543-544`: **Fix list indentation**

Adjust the indentation of the unordered list items to be consistent with the rest of the document:

```diff
-  - Use single `=` for variable assignments (e.g., `result = "approve"`).
-  - Avoid using double `==`, as it is a comparison operator, not an assignment.
+ - Use single `=` for variable assignments (e.g., `result = "approve"`).
+ - Avoid using double `==`, as it is a comparison operator, not an assignment.

🧰 Tools

🪛 Markdownlint (0.35.0)

543-543: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

544-544: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4c01492 and 174e77e.

📒 Files selected for processing (1)

• docs/Support/FAQ.md (4 hunks)

🧰 Additional context used

🪛 Markdownlint (0.35.0)

docs/Support/FAQ.md

543-543: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

544-544: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)