Skip to content

Commit 2cfcd88

Browse files
authored
docs(readme): finalize client-safety FAQ; fix headings and wording; normalize BARX-style
1 parent 99beb16 commit 2cfcd88

1 file changed

Lines changed: 37 additions & 10 deletions

File tree

README.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -245,17 +245,44 @@ tier1-uk-bank-fx-streaming-gcp/
245245

246246
## Reuse this pattern
247247

248-
---
248+
### Minimal commit plan (copy these messages)
249+
250+
1. **docs(readme):** add Quick Facts, real CI + Release badges, link SECURITY.md; remove extra horizontal rule under Quick Facts
251+
2. **docs(readme):** fix links to diagrams (use `.md` pages with ```mermaid blocks); add links to ADR and Release Notes
252+
3. **docs:** create required stubs (or remove dead links):
253+
- `docs/05-data-models.md`
254+
- `docs/06-observability-and-slos.md`
255+
- `docs/07-cost-controls.md`
256+
- `docs/08-ci-cd.md`
257+
- `docs/09-license-notes.md`
258+
259+
> **Option A (rename files):** replace any `docs/*.mmd` with Markdown pages, keeping Mermaid code blocks unchanged.
260+
261+
### Commands
262+
263+
```bash
264+
# Normalize diagram pages to .md and preserve history
265+
git ls-files 'docs/*.mmd' | while read f; do git mv "$f" "${f%.mmd}.md"; done
266+
git grep -n '\.mmd' -- docs | cut -d: -f1 | sort -u | while read f; do sed -i 's/\.mmd/\.md/g' "$f"; done
267+
268+
# Remove stray placeholder if present
269+
sed -i '/contentReference\[oaicite:0\]{index=0}/d' README.md
270+
```
271+
272+
### FAQ
273+
274+
**Is this affiliated with any bank or with Barclays/“BARX”?**
275+
No. This is a sanitized case-study for learning and portfolio demonstration. No client code/data, no access to any bank systems.
276+
277+
**What does “BARX-style” mean, and why not write the bank name?**
278+
“BARX-style” describes the pattern we simulate—real-time FX quotes/trades → Pub/Sub → Dataflow → BigQuery—common in Tier-1 banks. We keep the repo client-agnostic and avoid real client names in public GitHub.
249279

250-
### Minimal commit plan (copy the messages)
280+
**Is any production or proprietary dataset used here?**
281+
No. All data is synthetic and generated locally; artifacts are generic.
251282

252-
1. `docs(readme): add quick-facts, real CI+Release badges; link SECURITY; remove duplicate hr`
253-
2. `docs(readme): fix Repo Map to .md for diagrams; add ADR + Release notes link`
254-
3. If any of 05–09 pages don’t exist, either **create stubs** or remove links:
255-
- `docs: add stubs for data models, slos/observability, cost controls, ci/cd, license`
283+
**Can this be used in production as-is?**
284+
This is an educational example. Review/harden per your org’s standards and the license in `LICENSE`.
256285

257-
**If you prefer Option A (rename files):**
258-
Rename any `docs/*.mmd``*.md` and keep the Mermaid code blocks unchanged.
286+
**Where is the sanitization policy?**
287+
See the Sanitization Note above and `ETHICS.md`.
259288

260-
That’s it. Publish `v0.1.1` after these edits and pin the release in LinkedIn Featured.
261-
::contentReference[oaicite:0]{index=0}

0 commit comments

Comments
 (0)