Get started
Start here — your first week
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 onboarding track for engineers, interns and students joining the SGGS Knowledge Base: what this project is, the one rule that overrides everything, and a five-day path to your first merged change.
https://docs.gurbanisoul.com/onboarding/
Welcome. This project is a study application over Sri Guru Granth Sahib Ji, the scripture and
living Guru of the Sikhs: a verbatim corpus of its 1,430 Angs, a search and verification engine, a
website (gurbanisoul.com) and an iOS app (Gurbani Soul). You do not need
to know Sikh scripture,
The one rule
The reverence checklist turns this into concrete habits for everyday engineering work. Read it before you touch anything that displays, searches, copies or stores text.
Five days to a merged change
| Day | Do | Read |
|---|---|---|
| 1 | Understand what the system is, why it is split into three repositories, and where each kind of change belongs. | How the repositories fit together · Architecture overview · Reverence checklist |
| 2 | Clone, install the pinned database, run the server, the website and this wiki on your machine; run the gates. | Run it locally |
| 3 | Read the rules every change must keep, then follow one search request from the browser to SQLite. | Engineering invariants · Search waterfall · Glossary |
| 4 | Pick a small change, branch from integration, open a pull request the way the project expects. | Your first pull request · Branching |
| 5 | Watch the checks, read what each one proves, see your change on staging, ask for the merge. | CI gates · Who to ask |
Three sentences to remember
- Scripture is data you never write. It arrives from the pinned database and is shown with its
Ang : Sri Guru Granth Sahib Ji · Ang N. Explanation is always labelled as explanation. - Everything is proven by CI. You cannot merge; the owner merges after every check is green and the change has been seen on staging. A deploy is verified by the running commit, not a version.
- Small, reviewed, reversible. One change per pull request, a conventional-commit title, the PR template filled in, and no tool attribution in commits — only the author’s name.
What you can contribute
Almost everything outside the scripture itself: search quality, the verification engine, the API, the website, the iOS app, documentation, diagrams, tests, tooling and the wiki you are reading. The learning paths group these by role, each a checklist of pages and exercises in order; the engineering handbook is the map of the rules.
Sri Guru Granth Sahib Ji — Knowledge Base wiki. Generated from commit c3d9360. Updated 27 September 2026. This copy may be out of date; the page is at https://docs.gurbanisoul.com/onboarding/