Reference
Repository map
Page actions
- View as Markdown (opens in a new tab)
- Ask ChatGPT (opens in a new tab)
- Ask Claude (opens in a new tab)
ChatGPT and Claude are third-party services. The link gives them this page's public address and a short instruction. This site records nothing.
Preview: the published page may be older or missing.
The three repositories — data, platform, app — and what every important path is for, one line each, as an expandable map with links into the code at the right ref.
https://docs.gurbanisoul.com/reference/repo-map/
Three repositories, one purpose each (ADR-0007). Open a folder to see what lives in it; every entry links to the file or directory on GitHub.
Algorythmos-AI/sggs-platform — the API and the web — serves exactly the database dataset.lock.json pins
dataset.lock.json— the sggs-data commit + database sha256/size this platform serveswebapp/— the stdlib server and the APIwebapp/serve.py— composition root: build identity, the ROUTES table, the HTTP layer, startupwebapp/sggs/— the five bounded contexts: core, search, reader, verification, insights, knowledgewebapp/verify.py— the quotation-verification enginewebapp/romannorm.py— the query-time Roman fold (byte-identical to the index-time fold)webapp/static/— the prebuilt website the server serveswebapp/tests/— server, contract and repo-gate tests
frontend/— the website's Astro source (built into webapp/static/)frontend/vercel.json— the gateway rewrites, generated by tools/gen_gateway.pyfrontend/public/contributors.json— the public-domain chronology of the Granth's contributors (vendored by the app)
contract/— the golden contract: recorded outputs of the engines plus openapi.json; vendored by the appgateway/routes.json— per environment, where /api traffic goes; frontend/vercel.json is generated from ittools/— generators, harnesses and gatestools/gen_golden_vectors.py— records the golden contract from the real functionstools/gen_openapi.py— contract/openapi.json from the route declarations and real responsestools/gen_gateway.py— frontend/vercel.json from serve.ROUTES and gateway/routes.jsontools/gen_route_table.py— docs/api/routes.md from the dispatcher and the OpenAPI declarationstools/contract_http.py— replays the golden contract over HTTP against any running APItools/roundtrip_harness.py— search recall: every line's own transliterationtools/casual_quote_harness.py— search recall: casualised fragments of real linestools/chaos_harness.py— search recall: adversarial attack files against a running servertools/docs_check.py— the wiki's gate: frontmatter, links, widgets, palette, scripture rule, posters, stamps, drifttools/fetch_sibling_docs.py— installs the sibling repositories' docs at their pinned commitstools/data_canary.py— production serves the pinned scripture byte for bytetools/perf_baseline.py— p50/p95 per context against one origin; the +10 % gate for the service splittools/slice_db.py— a service's database slice from the pinned one, proven equal in contenttools/build_api_functions.py— the per-context API functions deployed inside the web project
scripts/— ci, release, ops and data toolingscripts/data/fetch_dataset.py— installs db/sggs.sqlite from the pin, sha256-verified, atomicallyscripts/ci/— what the workflows call: wait for checks, smoke deploys, verify functionsscripts/release/— bump the unified version, preflight a release, prove a release completescripts/ops/verify_prod.py— prove what production serves by commit identityscripts/gh/apply_rulesets.sh— apply .github/rulesets/*.json to the repository
docs/— this wiki's pages (PR-reviewed Markdown; rendered by docs-site/)docs-site/— the Astro Starlight site over docs/: plugins, widgets, posters, gates, e2e.github/workflows/— every CI workflow — the CI gates map.github/rulesets/— the branch protection as codeqa/chaos/— adversarial search inputs for the chaos harnessMakefile— every developer and CI entry point: make help
Algorythmos-AI/sggs-data — the scripture: corpus, database, rebuild pipeline, gates, editorial ledger, evidence
corpus/sggs.jsonl— 60,658 verbatim line records, proven character for character against the PDFdb/sggs.sqlite— the published database (Git LFS), by commit and sha256pipeline/— PDF → corpus → database, every stage gatedpipeline/rebuild_all.sh— the one-command reproducible rebuildpipeline/build_corpus.py— extraction: page content, fix_text, segmentation, headers, post-passespipeline/sggs_pipeline.py— fix_text, transliteration, roman_norm, segment_units, detect_headerpipeline/reconcile.py— the corpus equals the PDF's text stream, character for characterpipeline/golden_test.py— nine groups of canonical structural checkspipeline/build_db.py— the SQLite tables and the FTS5 indexpipeline/build_ios_db.py— the iOS database pair, two profiles (vendored by the app)pipeline/ledger_check.py— code == the editorial ledger; a scripture change needs an entrypipeline/verify_regroup.py— only comp_id and line_no may change between databases
audit/— the evidence: editorial ledger, dataset fingerprint, data-quality and scripture baselinesdocs/— the data repository's docs (pinned and published on this wiki under /data/)Answer-Protocol.md— how Gurbani questions are answered from this knowledge base
Algorythmos-AI/gurbani-soul-ios — the app: SwiftUI, widgets, the bundled database pair, TestFlight and App Store tooling
vendor.lock.json— the platform contract and the database builder, pinned by commit and sha256 per filedataset.lock.json— the same sggs-data pin as the platformios/App/— the app target (project.yml → XcodeGen)ios/App/Sources/Data/LaunchIntegrity.swift— the fail-closed launch check against the manifestios/App/Sources/Persistence/SavedLine.swift— the bookmarks store and its versioned schema
ios/Packages/GurbaniSearchKit/— the Swift ports of search, verify, reader, timing, banis, insights — and their parity testsios/tools/testflight_archive.sh— the only sanctioned way to build a TestFlight or App Store candidateios/testflight-builds.json— the ledger of every uploadscripts/vendor_sync.py— re-vendor the contract or the database builder at a pinned commitdocs/— the app's docs (pinned and published on this wiki under /ios/)
On the rendered wiki this is an expandable map; on GitHub, the same map is
docs/reference/repo-map.json, one line per path, checked by
tools/gen_repo_map.py --check so that no listed path can go missing.
How to read it
- sggs-platform is this repository: the API and the website, and the wiki you are reading.
- sggs-data owns the scripture: nothing here writes it; it arrives by pin.
- gurbani-soul-ios owns the app: it vendors this repository’s contract at a release tag.
When a newcomer asks “what is this file?”, the answer belongs in the map. Add the path with a one-line purpose; the check refuses a path that does not exist.
Sri Guru Granth Sahib Ji — Knowledge Base wiki. Generated from commit c3d9360. Updated 25 September 2026. This copy may be out of date; the page is at https://docs.gurbanisoul.com/reference/repo-map/