Skip to content

docs: fix README inaccuracies from code review#104

Merged
wcatz merged 1 commit intomasterfrom
docs/readme-accuracy-fixes
Mar 13, 2026
Merged

docs: fix README inaccuracies from code review#104
wcatz merged 1 commit intomasterfrom
docs/readme-accuracy-fixes

Conversation

@wcatz
Copy link
Copy Markdown
Owner

@wcatz wcatz commented Mar 13, 2026

Summary

  • Stake snapshots: NtC primary, Koios fallback (was incorrectly Koios API only)
  • Add ntcHost to full mode config example (was missing entirely)
  • Fix stability window table: 3k/f and 4k/f are the margins, not freeze points
  • Remove dead ticker config key from quick start and config.yaml.example
  • Add /menu to Telegram commands table
  • Add localquery.go and securekey.go to architecture table

Test plan

  • Docs-only change, no code impact

Summary by CodeRabbit

  • Documentation

    • Updated configuration documentation with ntcHost option for node address settings.
    • Updated Era/Stability Window table with new column structure (Margin, Freeze Point, Slots Before Epoch End).
    • Enhanced Stake Snapshots documentation regarding query methods.
    • Extended Architecture section to document additional system components.
    • Added new /menu Telegram command documentation.
  • Chores

    • Removed ticker field from configuration example.

- Stake snapshots: NtC primary, Koios fallback (was "Koios API")
- Add ntcHost to full mode config example
- Fix stability window table: formulas were swapped with freeze points
- Remove dead ticker config key from quick start and config.yaml.example
- Add /menu command to Telegram commands table
- Add localquery.go and securekey.go to architecture table
@wcatz wcatz merged commit 63115c5 into master Mar 13, 2026
3 checks passed
@wcatz wcatz deleted the docs/readme-accuracy-fixes branch March 13, 2026 13:57
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 13, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 119cffe8-eaec-4af0-98e5-b7a0a68a52e2

📥 Commits

Reviewing files that changed from the base of the PR and between 1d25155 and 258582c.

📒 Files selected for processing (2)
  • README.md
  • config.yaml.example

📝 Walkthrough

Walkthrough

Documentation and configuration updates reflecting Node to Chain (NtC) integration for stake queries. Removed deprecated ticker field from configuration example, added NtC host configuration, updated stability window table format, and extended architecture documentation to include new NtC-related modules.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Updated Stake Snapshots section to prioritize NtC QueryPoolStakeSnapshots with Koios fallback; reformatted Era/Stability Window table; added /menu Telegram command; extended Architecture section to document localquery.go and securekey.go components.
Configuration Cleanup
config.yaml.example
Removed deprecated ticker field from lite mode configuration example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 With ticker gone and NtC in sight,
Our queries now dance in fresh light,
Snapshots from Node to Chain we trace,
Documentation finds its proper place,
Configuration clean, we hop with delight! 🌟

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/readme-accuracy-fixes
📝 Coding Plan
  • Generate coding plan for human review comments

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.

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.

1 participant