Escalation Events Properties and Form Styling Documentation

[usama9500]

• Added a section on the Escalation Event Properties Section
• Added a section on how to configure Side-by-Side Field Layout in Forms

Summary by CodeRabbit

• Documentation
  • Updated the heading for consistency in the Forms documentation.
  • Added instructions for configuring side-by-side field layout in forms.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates include improvements to the documentation, focusing on form layouts and workflow management. These changes introduce guidance on configuring side-by-side field layouts in forms using the ui:layout attribute. Additionally, there is detailed information on setting up Escalation Events Properties in SpiffWorkflow, covering triggers, handling, and additional settings for efficient escalation management within workflows.

Changes

File Path	Change Summary
.../Forms.md	Updated heading to "UI Schema Example" for consistency and added a section on configuring side-by-side field layout in forms using ui:layout.
.../escalation_events.md	Added a new section detailing the configuration of Escalation Events Properties in SpiffWorkflow, including triggers, handling, and additional settings.

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 330f18f and bac23b3.

Files selected for processing (2)

• docs/Building_Diagrams/Forms.md (2 hunks)
• docs/Building_Diagrams/escalation_events.md (1 hunks)

Files skipped from review due to trivial changes (1)

• docs/Building_Diagrams/escalation_events.md

Additional comments: 2

docs/Building_Diagrams/Forms.md (2)

• 335-335: The heading "UI Schema Example" is correctly updated for consistency, aligning with the documentation's style guide.
• 351-398: The new section on configuring side-by-side field layout in forms is comprehensive, providing clear steps, an illustrative example, and an explanation of how the ui:layout attribute works. However, ensure that the example JSON is valid and correctly formatted to prevent confusion.

[burnettk]

should be good after the side by side stuff is merged with the existing docs or removed.

[burnettk]

maybe just a comma here: "exceptional circumstances. and decide on a unique identifier"

[usama9500]

Done

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between bac23b3 and 82a8dbf.

Files selected for processing (1)

• docs/Building_Diagrams/Forms.md (4 hunks)

Files skipped from review as they are similar to previous changes (1)

• docs/Building_Diagrams/Forms.md

[usama9500]

should be good after the side by side stuff is merged with the existing docs or removed.

Done, merged with existing one.