Skip to content

Polish README for public app linking#1

Merged
Spider333 merged 1 commit into
mainfrom
polish/readme-collapsible-sections
Mar 13, 2026
Merged

Polish README for public app linking#1
Spider333 merged 1 commit into
mainfrom
polish/readme-collapsible-sections

Conversation

@Spider333
Copy link
Copy Markdown
Owner

@Spider333 Spider333 commented Mar 13, 2026

Summary

  • Wrap all 16 community directory categories in collapsible <details> sections with tool counts — reduces initial scroll to a scannable list
  • Add <a id> anchors so ToC links still work inside collapsed sections
  • Sync Toolkit descriptions with Community Directory (source of truth) — fixes Xapo, Revolut, Bank of Georgia, EtherFi, Kraken, Firefish, Resolv, Gauntlet
  • Fix Gauntlet product name inconsistency ("USD Alpha" → "AlphaUSD")
  • Set repo homepage to polystate.io, updated repo description
  • Include Zodl URL update + editor's pick flag

Test plan

  • View README on GitHub — verify <details> sections render as collapsible
  • Click ToC anchor links — verify they scroll to correct collapsed section
  • Confirm gh repo view shows polystate.io homepage
  • Spot-check Toolkit descriptions match Community Directory

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated service descriptions and labels across multiple sections for clarity and accuracy
    • Improved section organization with collapsible details and enhanced navigation
    • Enhanced visual presentation with updated markers and standardized naming conventions
  • Chores

    • Updated tool entry with new link and status

…sync

- Wrap all 16 community directory categories in <details><summary> tags
  to reduce initial scroll from ~420 lines to a scannable list
- Add <a id> anchors so ToC links still work with collapsed sections
- Sync Toolkit descriptions with Community Directory (source of truth):
  Xapo (add USD yield), Revolut (add MiCA + crypto trading),
  Bank of Georgia (add Club tier + tax residency acceptance),
  EtherFi (specify wETH cashback), Kraken, Firefish, Resolv, Gauntlet
- Fix Gauntlet product name: "USD Alpha" → "AlphaUSD"
- Include Zodl URL update (zashi.app → zodl.com) + editor's pick
- Set repo homepage to polystate.io, update repo description

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

PR Auto-Review

Issues found — this PR needs changes before it can be merged:

  • Affiliate link detected. Community submissions must not contain affiliate/referral links. Only maintainers may add these (see CONTRIBUTING.md).

Please fix these issues and update your PR. See CONTRIBUTING.md for guidelines.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 13, 2026

📝 Walkthrough

Walkthrough

Documentation updates across README.md standardize service descriptions for cryptocurrency platforms and exchanges with clarified regulatory notes, expanded naming conventions, and consistent phrasing. A single tool entry in tools.json was modified with a URL update and pick flag status change.

Changes

Cohort / File(s) Summary
Documentation & Service Descriptions
README.md
Updated descriptions for exchanges (Kraken, Xapo), DeFi platforms (EtherFi, Gauntlet AlphaUSD), and fintech services (Revolut, Bank of Georgia). Standardized phrasing around regulatory context (MiCA licensing, CRS coverage), expanded card/platform naming, and adjusted visual markers across multiple category sections.
Tool Registry Update
tools.json
Updated entry id 5 (Wallets & Hardware category): URL changed to https://zodl.com and pick flag status changed from false to true.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hopping through docs, a tale so bright,
Services polished, descriptions take flight,
Regulatory notes now crystal and clear,
One tool gets featured—a prize held dear!
With clarity comes crypto's light.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures the main change: polishing the README for public app linking with collapsible sections and metadata updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch polish/readme-collapsible-sections
📝 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.

@github-actions
Copy link
Copy Markdown

PR Auto-Review

Issues found — this PR needs changes before it can be merged:

  • Affiliate link detected. Community submissions must not contain affiliate/referral links. Only maintainers may add these (see CONTRIBUTING.md).

Please fix these issues and update your PR. See CONTRIBUTING.md for guidelines.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

83-83: Minor description variance between Toolkit and Directory (acceptable).

The Toolkit Revolut entry (line 83) omits the MiCA licensing date "(Oct 2025)" that appears in the Community Directory entry (line 260). This is fine since the Toolkit serves as a condensed summary, but you may want to keep them identical for easier maintenance.

Also applies to: 260-260

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 83, The Revolut table row in the Toolkit README has a
condensed description missing the MiCA licensing date present in the Community
Directory entry; update the Revolut entry string (the table row containing
"Revolut | CRS multi-currency digital banking with crypto trading built in.
MiCA-licensed | [revolut.com](https://revolut.com) |") to include the licensing
date "(Oct 2025)" so it matches the Community Directory Revolut entry, and
ensure both entries remain identical to simplify future maintenance.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 83: The Revolut table row in the Toolkit README has a condensed
description missing the MiCA licensing date present in the Community Directory
entry; update the Revolut entry string (the table row containing "Revolut | CRS
multi-currency digital banking with crypto trading built in. MiCA-licensed |
[revolut.com](https://revolut.com) |") to include the licensing date "(Oct
2025)" so it matches the Community Directory Revolut entry, and ensure both
entries remain identical to simplify future maintenance.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 36bbe64b-3bf7-4bb7-8e19-725a2c755082

📥 Commits

Reviewing files that changed from the base of the PR and between 5053799 and 3b856d5.

📒 Files selected for processing (2)
  • README.md
  • tools.json

@Spider333 Spider333 merged commit aa83239 into main Mar 13, 2026
3 checks passed
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