docs: added rule building flow document

[ahmad-paysys]

SPDX-License-Identifier: Apache-2.0

What did we change?

Added a new documentation file Technical/Deployment-Guides/Rule Building Flow.md describing the rule building flow.

Why are we doing this?

To provide clear, centralized documentation on the rule building process for contributors and operators referencing the deployment guides.

How was it tested?

• Locally
• Development Environment
• Not needed, changes very basic
• Husky successfully run
• Unit tests passing and Documentation done

Summary by CodeRabbit

• Documentation
  • Added a comprehensive setup and deployment guide for the Rule Studio, DevTestOps, and Rule Executer workflow.
  • Documented prerequisites, configuration, secrets, environment variables, repository bootstrapping, runner setup, and deployment steps.
  • Added simulation instructions, smoke tests, troubleshooting guidance, known issues, and operational references.
  • Documented current container publishing limitations and available alternatives.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a 731-line deployment guide covering Rule Studio architecture, prerequisites, DevTestOps configuration, per-rule deployment, local simulation, publishing options, environment variables, known issues, smoke tests, and troubleshooting.

Changes

Rule Building Flow Documentation

Layer / File(s)	Summary
Architecture and service prerequisites Technical/Deployment-Guides/Rule Building Flow.md	Documents the stack architecture, required tooling and credentials, TAZAMA_TOKEN encryption, DevTestOps configuration, runtime requirements, and health checks.
Per-rule repository deployment Technical/Deployment-Guides/Rule Building Flow.md	Describes template-based repository creation, workflows, runner setup, BuildKit secrets, connectivity, and rule-container environment variables.
Studio startup and simulation Technical/Deployment-Guides/Rule Building Flow.md	Documents backend and frontend environment configuration, local startup, simulation flow, and the NATS subject mismatch.
Publishing, references, and validation Technical/Deployment-Guides/Rule Building Flow.md	Adds Docker Hub and GHCR guidance, consolidated variables, known issues, smoke tests, troubleshooting, and the change log.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Suggested labels: documentation

Poem

A rabbit hops through rules tonight,
From NATS streams to runners bright.
Tokens tucked and containers spun,
Smoke tests prove the work is done.
“Deploy!” cries Bun beneath the moon.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly reflects the main documentation change and is concise enough for history scanning.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat-paysys-rule-building-flow

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Technical/Deployment-Guides/Rule` Building Flow.md:
- Around line 323-325: Update the npm authentication steps around the npm
registry login to avoid writing TAZAMA_TOKEN to the persistent ~/.npmrc; use a
temporary npm configuration or NODE_AUTH_TOKEN instead, and guarantee removal of
any temporary credentials with a cleanup trap after npm whoami completes.
- Around line 607-615: Update the “9.1 GitHub org secrets” table so
DOCKERHUB_NAMESPACE is classified consistently with section 8.2 as an
organization variable; remove it from the secrets table and ensure the variables
table documents its workflow consumption.
- Around line 339-351: The deployment guide must not present hardcoded database
or Redis credentials as production values. Update the environment-variable table
and related docker run instructions around RAW_HISTORY_DATABASE_PASSWORD,
POSTGRES_PASSWORD, and REDIS_PASSWORD so environment-specific secrets are
explicitly read and passed through, or clearly label these entries as
non-production placeholders and document the required Redis secret override.
- Around line 187-188: Update the health check and bootstrap examples in the
deployment guide to use the configured PORT value or a clearly documented port
placeholder instead of hardcoding 3050. Apply this consistently to the examples
near the PORT configuration table and the referenced sections, while preserving
the existing command behavior.
- Around line 145-168: Update the AES example’s key and IV handling to match the
documented openssl hex output: decode ENCRYPTION_KEY and ENCRYPTION_IV as hex
instead of UTF-8, and revise the surrounding comments and byte-length
verification note to describe the decoded 32-byte key and 16-byte IV.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 17be0fb5-96cb-47ab-b4af-a12dfc805a8d

📥 Commits

Reviewing files that changed from the base of the PR and between 6d47f3a and 12d1056.

📒 Files selected for processing (1)

• Technical/Deployment-Guides/Rule Building Flow.md