Skip to content

Make socks5 more visible in docs#6917

Open
mfahampshire wants to merge 1 commit into
developfrom
max/socks5-docs-update
Open

Make socks5 more visible in docs#6917
mfahampshire wants to merge 1 commit into
developfrom
max/socks5-docs-update

Conversation

@mfahampshire

@mfahampshire mfahampshire commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added a new Rust SDK guide for SOCKS5 proxy support, including setup examples, DNS handling, configuration options, and related references.
    • Updated developer docs to highlight SOCKS5 as the recommended proxy-mode option.
    • Refreshed CLI help documentation formatting for several commands to improve readability.
    • Updated developer navigation and proxy support references.
    • Brought recorded API-scraping counts and a timestamp page up to date.

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-nextra Ready Ready Preview, Comment Jun 25, 2026 1:59pm
nym-explorer-v2 Ready Ready Preview, Comment Jun 25, 2026 1:59pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
nym-node-status Ignored Ignored Jun 25, 2026 1:59pm

Request Review

@mfahampshire mfahampshire requested review from merve64 and serinko June 25, 2026 13:55
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

An error occurred during the review process. Please try again later.

📝 Walkthrough

Walkthrough

Updated generated documentation snapshots for API scraping counts, timestamps, and CLI help formatting. Added a new Rust developer page for the SOCKS5 module, along with navigation metadata and cross-links from existing developer docs.

Changes

Generated documentation outputs

Layer / File(s) Summary
Scraped metrics refresh
documentation/docs/components/outputs/api-scraping-outputs/nodes-count.json, documentation/docs/components/outputs/api-scraping-outputs/time-now.md
API-scraping counts and the displayed timestamp were updated.
CLI help reflow
documentation/docs/components/outputs/command-outputs/nym-api-help.md, documentation/docs/components/outputs/command-outputs/nym-node-help.md, documentation/docs/components/outputs/command-outputs/nym-node-run-help.md, documentation/docs/components/outputs/command-outputs/nymvisor-help.md
Rendered help snapshots were reformatted for nym-api, nym-node, nym-node run, and nymvisor.

Rust SOCKS5 developer docs

Layer / File(s) Summary
SOCKS5 guide
documentation/docs/pages/developers/rust/socks5.mdx
A new Rust documentation page describes the SOCKS5 proxy module, usage examples, and related links.
Developer nav metadata
documentation/docs/pages/developers/_meta.json, documentation/docs/pages/developers/rust/_meta.json
The developer section metadata now defines rust and socks5 entries with title and theme fields.
SOCKS5 references
documentation/docs/pages/developers/clients/socks5.mdx, documentation/docs/pages/developers/index.mdx, documentation/docs/pages/developers/rust.mdx
Existing developer pages now refer to SOCKS5 module naming and links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

  • nymtech/nym#6739: Updates the same documentation outputs, including nodes-count.json, time-now.md, and nym-node-run-help.md.
  • nymtech/nym#6769: Touches the same API-scraping output files nodes-count.json and time-now.md.
  • nymtech/nym#6866: Overlaps on the CLI help snapshots for nym-api, nym-node, nym-node-run, and nymvisor.

Suggested labels

documentation

Suggested reviewers

  • benedettadavico
  • merve64

Poem

I hopped through docs with velvet paws,
and found SOCKS5 without a pause.
The help text shone, the pages gleamed,
like carrots in a moonlit dream. 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: increasing SOCKS5 visibility across the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch max/socks5-docs-update

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.

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.

2 participants