Create documents and themes for each workflow type

[gaelyn]

Summary by CodeRabbit

• New Features

  • Introduced structured document templates (dynamic, embedded, file-feed, project spaces) with detailed instructions and features for importing data into PLM Show.
  • Launched theme configuration objects for different space types, enhancing visual consistency and user experience.

• Documentation

  • Added comprehensive guidance within new document templates, facilitating user navigation and understanding of data import processes.

[coderabbitai]

Walkthrough

The recent updates aim to enhance user guidance and UI consistency in PLM workflows by introducing new document templates and themes for various spaces. These changes focus on improving user experience through detailed instructions and consistent visual styling across different spaces, along with refining configuration handling for better space setup.

Changes

Files	Change Summary
.../actions/plmEmbeddedSpaceConfigure.ts, .../actions/plmFileFeedSpaceConfigure.ts, .../actions/plmProjectSpaceConfigure.ts	Updated to create documents and set themes when spaces are created; adjusted configureSpace function parameters for improved configuration handling.
.../documents/dynamic-space-document.ts, .../documents/embedded-space-document.ts, .../documents/file-feed-space-document.ts, .../documents/project-space-document.ts	Introduced new structured document templates with detailed instructions and Flatfile feature highlights to enhance user guidance and workflow comprehension.
.../themes/dynamic-space-theme.ts, .../themes/embedded-space-theme.ts, .../themes/file-feed-space-theme.ts, .../themes/project-space-theme.ts	Added new theme configuration objects for different space UIs, defining color schemes and styles to maintain visual consistency and improve the overall user experience.

Possibly related issues

• add reusable spaces to create-react-app example create-flatfile-react#9: The enhancements in this update align with the goal of improving code readability and maintainability by introducing structured documents and themes for spaces. These changes demonstrate effective space utilization in the create-react-app example, ensuring consistency with existing code patterns for better development practices.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 9fe7558 and 643b233.

Files selected for processing (3)

• src/workflows/plm/documents/embedded-space-document.ts (1 hunks)
• src/workflows/plm/documents/file-feed-space-document.ts (1 hunks)
• src/workflows/plm/documents/project-space-document.ts (1 hunks)

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

• src/workflows/plm/documents/embedded-space-document.ts
• src/workflows/plm/documents/file-feed-space-document.ts
• src/workflows/plm/documents/project-space-document.ts

---

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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: 1

[coderabbitai]

Actionable comments posted: 1

[johnmosesman]

Swap out the HCM verbiage and lgtm!