Skip to content

Create glossary.md for Sentrix terminology#18

Open
koteshyelamati wants to merge 2 commits into
sentrix-labs:mainfrom
koteshyelamati:docs/add-glossary
Open

Create glossary.md for Sentrix terminology#18
koteshyelamati wants to merge 2 commits into
sentrix-labs:mainfrom
koteshyelamati:docs/add-glossary

Conversation

@koteshyelamati

Copy link
Copy Markdown
Contributor

Closes #14

Changes

Added docs/glossary.md — a comprehensive glossary of Sentrix-specific terms that newcomers encounter across the docs.

Terms defined:
BFT, Block Time, DPoS, Epoch, EVM, Finality, Halving, Jail/Unjail, libp2p, MDBX, Precommit/Prevote, revm, SRX/sentri, Staking, Validator/Full Node, Voyager DPoS+BFT

Each entry includes a concise plain-English definition and cross-links to the relevant deep-dive docs pages (architecture/overview, tokenomics/staking, operations/validator-guide, etc.).

Added a glossary of Sentrix-specific terms with definitions.
@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@koteshyelamati, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 57 minutes and 50 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b69a0bea-9de1-4246-8472-376747dcc82b

📥 Commits

Reviewing files that changed from the base of the PR and between 1095bfe and 17b15cf.

📒 Files selected for processing (1)
  • docs/glossary.md
✨ 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 and usage tips.

@satyakwok satyakwok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for this — genuinely useful page and the structure is clean. Two accuracy fixes before it lands, left inline. Appreciate you picking up the glossary.

Comment thread docs/glossary.md Outdated

## SRX / sentri

**SRX** is the native token of Sentrix Chain. *Sentri* is an informal nickname. SRX is used for gas fees, staking, and governance.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Small but important: sentri isn't a nickname for SRX — it's the smallest unit. 1 SRX = 100,000,000 sentri (the wei/satoshi of Sentrix). Could you reword, e.g.: "Sentri is the smallest unit of SRX — 1 SRX = 100,000,000 sentri."

Comment thread docs/glossary.md Outdated

## Jail / Unjail

When a validator misses too many blocks or double-signs, it is *jailed*: removed from the active set and its stake slashed. A jailed validator must submit an *unjail* transaction (after a cooldown period) to re-enter the active set.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Worth double-checking against the staking docs: downtime jailing and slashing aren't necessarily the same event (downtime → jail; double-sign/equivocation → slash), and re-entry on Sentrix goes through the unjail / AddSelfStake path rather than a generic "unjail transaction". Could you confirm and soften the wording (e.g. "may be slashed")?

Clarified the definitions of 'Jail / Unjail' and 'SRX / sentri' in the glossary.
@satyakwok

Copy link
Copy Markdown
Member

Content fixes look good — sentri (1 SRX = 100,000,000 sentri) and the jail/slash distinction are both correct now, and I checked Epoch against the staking docs (28,800-block epochs, active-set recompute on boundary) — accurate.

One thing left before merge: like the FAQ, glossary.md is a top-level doc, so it needs an entry in sidebars.ts (add 'glossary' alongside 'faq'). Without it the page is reachable by URL but won't show up in the sidebar nav. Add that and this is good to merge.

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.

docs: add a glossary of Sentrix terms

2 participants