docs: Minor docs improvements & fixing doc linting errors

[artrixdotdev]

Summary by CodeRabbit

• Documentation
  • Improved public API docs across engine, torrent, tracker, and UDP tracker areas.
  • Clarified peer connection and handshake flow, including when peers are ignored.
  • Standardized links and cross-references for consistency and easier navigation.
  • Refined field and message descriptions to reduce ambiguity and improve readability.
  • No functional changes or runtime impact.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Doc-comment-only updates across engine, torrent, and tracker modules: adjusted intra-doc links, clarified Torrent::append_peer behavior, and corrected type/module references. No code, signatures, behavior, or control-flow changes.

Changes

Cohort / File(s)	Summary of Changes
Engine docs crates/libtortillas/src/engine/mod.rs	Simplified intra-doc links from [Torrent](crate::torrent::Torrent) to [Torrent] in EngineMessage and Engine field docs.
Torrent docs crates/libtortillas/src/torrent/mod.rs	Expanded Torrent::append_peer docs: clarified PeerActor spawning, handshake behavior with/without PeerStream, and ignore conditions; no code changes.
Tracker docs crates/libtortillas/src/tracker/mod.rs, crates/libtortillas/src/tracker/udp.rs	Updated doc references: PeerActor path to crate::peer::PeerActor; GetStats reference to TrackerInstance::stats; udp.rs comment now references UdpServer::send_message and UdpTracker::to_retry_error. No logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs: Fix doc invalid doc links #38 — Prior doc-only fixes in tracker and torrent modules; similar cross-reference updates.
• refactor: send_handshake and receive_handshake #102 — Handshake flow refactor referenced by the updated Torrent::append_peer documentation.

Suggested labels

med prio

Suggested reviewers

• kurealnum

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 2cb0cd7 and 4b9f599.

📒 Files selected for processing (4)

• crates/libtortillas/src/engine/mod.rs (2 hunks)
• crates/libtortillas/src/torrent/mod.rs (1 hunks)
• crates/libtortillas/src/tracker/mod.rs (2 hunks)
• crates/libtortillas/src/tracker/udp.rs (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/linting-errors

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.