Document generated Open Flow skill resources

[crimx]

Summary

• Add @oomol-lab/open-flow as a development dependency and ignore its generated reference files.
• Document how to generate the references and clarify Flow deployment, team, and Workbench sign-in guidance in the skill.

Testing

• Not run (not requested)

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Updated Open Flow guidance for deployment, account and team selection, and hosted or self-hosted sign-in.
  • Clarified how to handle temporary browser sign-in codes and where service credentials should be kept.
  • Added contributor guidance for accessing Open Flow reference materials and preparing the development environment.

Walkthrough

The changes add postinstall synchronization of two Open Flow reference files from @oomol-lab/open-flow and ignore the generated files. They remove the tracked reference copies, add contributor instructions for generating them, and expand the Open Flow skill guidance for deployment, invocation, credentials, and Workbench sign-in.

Sequence Diagram(s)

sequenceDiagram
  participant Bun
  participant Postinstall as package.json postinstall
  participant SyncScript as sync-open-flow-docs.ts
  participant OpenFlowPackage as @oomol-lab/open-flow
  participant References as shared/oo/references
  Bun->>Postinstall: run postinstall
  Postinstall->>SyncScript: run with Bun
  SyncScript->>OpenFlowPackage: resolve and read reference files
  SyncScript->>SyncScript: render with oo flow
  SyncScript->>References: write generated files

Loading

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to b081a

The documented install workflow generates the Open Flow references before they are used. No confirmed merge-blocking issue remains.

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check		The title clearly describes the pull request, but it does not use the required <type>(<scope>): <subject> format.	Rewrite the title in the required format, for example: docs(open-flow): document generated skill resources. English only is already satisfied.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description check		The description accurately summarizes the dependency, generated references, documentation updates, and testing status.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

---

---

• Fix all pre-merge checks with AI

✨ Finishing Touches

✨ Simplify code

• Commit to this branch
• Create a new PR

---

---

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

🔇 Additional comments (6)

.gitignore (1)

43-45: LGTM!

CONTRIBUTING.md (1)

121-127: LGTM!

package.json (1)

30-30: 🩺 Stability & Availability

The published packages do not retain this postinstall script. The root package is private, and the release process generates wrapper and platform manifests without a scripts field before packing them. Consumer installs therefore do not run this script. No change to prepare is needed.

contrib/skills/shared/oo/SKILL.md (2)

63-64: 🔒 Security & Privacy

The repository does not establish a defect in this guidance. src/application/commands/auth/web.ts only requests a session code and constructs the exchange URL; it does not implement the Hosted exchange endpoint. The repository documentation already defines the Hosted code as short-lived and one-time. The client tests do not prove those server guarantees, but their limited coverage does not show that the documentation is false. No repository-owned endpoint contradicts the claim.

---

65-65: 🔒 Security & Privacy

The self-hosted authentication claim is established by the repository documentation. The CLI returns a direct Server Workbench URL without sending a request or placing the operator token in the URL. No qualification is required.

contrib/skills/sync-open-flow-docs.ts-9-13 (1)

9-13: 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win

⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.

Write generated files atomically and handle resolve failures.

writeFile writes directly to the target path. An interrupted run can leave a partial file. Write to a temporary file in the same directory, then call rename. Also, if the package or the referenced file is missing in the installed version, import.meta.resolve throws an unclear error. Catch it and name the package and file in the message.

Source: Learnings

---

ℹ️ Review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Essentials
• Run ID: 7e79b709-d8e2-4533-bb94-2e6a4d235ffa

📥 Commits

Reviewing files that changed from the base of the PR and between b04cd14 and b081af3.

⛔ Files ignored due to path filters (1)

• bun.lock is excluded by !**/*.lock

📒 Files selected for processing (7)

• .gitignore
• CONTRIBUTING.md
• contrib/skills/shared/oo/SKILL.md
• contrib/skills/shared/oo/references/flow-authoring.md
• contrib/skills/shared/oo/references/flow-n8n-conversion.md
• contrib/skills/sync-open-flow-docs.ts
• package.json

💤 Files with no reviewable changes (2)

• contrib/skills/shared/oo/references/flow-authoring.md
• contrib/skills/shared/oo/references/flow-n8n-conversion.md

Included review availability: This review used your included allowance. 2 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.