VDB-4: Add Glossary page to Venus documentation#359
Draft
trumpgpt-bot wants to merge 1 commit into
Draft
Conversation
Add getting-started/glossary.md defining the core Venus terms a new user meets (vToken, Comptroller, Core Pool, Isolated Pools, Collateral Factor, Liquidation, Supply/Borrow APY, XVS, VAI, Venus Prime), each 1-2 sentences with a link to the relevant deep-dive page. Link the page in SUMMARY.md under Getting Started. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
getting-started/glossary.md— an H1 "Glossary" page with one H3 entry per term (matching the H3 heading style used ingetting-started/faq.md). Each term has a 1–2 sentence plain-English definition followed by a[Read more →]link to the existing deep-dive page. Covers all 11 terms from the spec: vToken, Comptroller, Core Pool, Isolated Pools, Collateral Factor, Liquidation, Supply APY, Borrow APY, XVS, VAI, Venus Prime.SUMMARY.md— added* [Glossary](getting-started/glossary.md)to the "Getting Started" section, immediately after the FAQ entry.No other files were modified.
Link verification
All 9 distinct
Read more →link targets were confirmed to exist in the repo before writing:guides/market-interaction/supply-borrow.md,technical-reference/contracts-overview.md,README.md,whats-new/isolated-pools.md,guides/market-interaction/liquidation.md,risk/interest-rate-model.md,tokens/xvs.md,tokens/vai.md,whats-new/prime-yield.md.Tests / linting
The repo's only checks are remark markdown lint scripts (
format:check). Afteryarn install, ran:Result for the two changed files:
Both changed files are clean. (The other warnings in the full output are pre-existing issues in unrelated files, not introduced by this change.)
Risks
Documentation-only change; no code or on-chain impact. Relative links use the
../prefix consistent with other pages ingetting-started/.Opened by the Venus dev bot. Review required; the bot cannot merge.