Skip to content

docs: add redbark hosting guide#2817

Open
oscargws wants to merge 1 commit into
we-promise:mainfrom
oscargws:docs/redbark-hosting-guide
Open

docs: add redbark hosting guide#2817
oscargws wants to merge 1 commit into
we-promise:mainfrom
oscargws:docs/redbark-hosting-guide

Conversation

@oscargws

@oscargws oscargws commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #2794. Adds a setup guide for the Redbark provider at docs/hosting/redbark.md, same shape as the plaid guide: creating an account, getting an API key, adding it under Settings > Providers, and how syncing behaves (initial backfill, incremental lookback, dedup, the REDBARK_INCLUDE_PENDING toggle). Also adds Redbark to the provider integrations list in the onboarding guide.

Docs only, no code changes.

Summary by CodeRabbit

  • Documentation
    • Added setup and troubleshooting guidance for connecting Redbark to Sure.
    • Documented account synchronization, transaction imports, pending transaction handling, and API key requirements.
    • Added Redbark to the onboarding guide’s list of supported integrations.

- new docs/hosting/redbark.md covering account setup, api keys, linking and sync behaviour
- listed redbark in the onboarding guide's provider integrations
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 96e12065-c413-4a61-be00-dc410486cbf4

📥 Commits

Reviewing files that changed from the base of the PR and between c9a28e1 and 47b39f5.

📒 Files selected for processing (2)
  • docs/hosting/redbark.md
  • docs/onboarding/guide.md

📝 Walkthrough

Walkthrough

Adds documentation for configuring and using the Redbark integration, including synchronization and troubleshooting details, and lists Redbark among the onboarding integration options.

Changes

Redbark integration documentation

Layer / File(s) Summary
Redbark setup and synchronization documentation
docs/hosting/redbark.md
Documents account and API key setup, provider linking, synchronization windows, balance updates, transaction deduplication, pending transaction handling, and troubleshooting.
Onboarding integration listing
docs/onboarding/guide.md
Adds Redbark as an Australian banks integration option.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a Redbark hosting guide.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 47b39f5d59

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/hosting/redbark.md
REDBARK_INCLUDE_PENDING=true
```

When a pending transaction settles, the posted version replaces it automatically.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Qualify pending replacement behavior

This overstates what the importer can guarantee when REDBARK_INCLUDE_PENDING is enabled: Redbark rows are imported without a provider-supplied pending_transaction_id, so the shared adapter only auto-claims a settled transaction via the fallback exact amount/currency/date-window match (app/models/redbark_account/transactions/processor.rb, app/models/account/provider_import_adapter.rb). If the bank changes the amount or details when the pending transaction posts, users can still end up with both entries rather than an automatic replacement, so the guide should warn that reconciliation is best-effort and duplicates may need review.

Useful? React with 👍 / 👎.

@jjmata jjmata left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only addition, follows the existing docs/hosting/plaid.md shape (account setup → API key → Settings > Providers → sync behavior → troubleshooting) and correctly cross-links from the onboarding guide's provider list. Nothing to flag.


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants