Clean up docs

[jiwenc-nv]

Description

1. Move devices to the top level entities on the left side-bar
2. Fix deadlinks

Fixes #(issue)

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update

Testing

Checklist

• I have read and understood the contribution guidelines
• I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
• I have made corresponding changes to the documentation
• I have added tests that prove my fix/feature works (or explained why not)
• I have signed off all my commits (git commit -s) per the DCO

Summary by CodeRabbit

• Documentation
  • Added guidance for configuring the retargeting pipeline when creating custom device plugins.
  • Reorganized device documentation navigation and updated links to device trackers and plugins.
  • Updated build, teleoperation, and MCAP replay instructions for improved accuracy and readability.
  • Improved parsing of wrapped code-role references in documentation.
  • Removed the obsolete device interface index page and module index link.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes normalize whitespace when parsing code roles, add device-plugin retargeting guidance, reorganize device and reference documentation navigation, update a CMake file reference, correct the documented DeviceIOSession header path, remove the module index link, and format the default MCAP replay URL as inline code.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is related to the change, but it is too generic to convey the main documentation updates.	Use a more specific title that mentions the device docs navigation and link fixes, e.g. 'Reorganize device docs and fix broken links.'

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch jiwenc/move-devices-docs

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/source/device/add_device.rst`:
- Line 1: Add the repository-standard REUSE SPDX copyright and license header at
the beginning of the documentation file, before the
device-interface-device-plugin Sphinx label. Preserve the existing label and all
following content unchanged.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c2a08e67-af39-45ca-89af-b2185475e5a5

📥 Commits

Reviewing files that changed from the base of the PR and between 26821bb and 1bb444f.

📒 Files selected for processing (8)

• docs/source/conf.py
• docs/source/device/add_device.rst
• docs/source/device/index.rst
• docs/source/getting_started/build_from_source/index.rst
• docs/source/getting_started/lerobot/devices.rst
• docs/source/getting_started/teleop_session.rst
• docs/source/index.rst
• docs/source/references/mcap_record_replay.rst

💤 Files with no reviewable changes (1)

• docs/source/device/index.rst

[coderabbitai]

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

Add the required REUSE SPDX header.

This file starts at Line 1 with a Sphinx label but has no standard SPDX copyright/license block, unlike the other changed documentation files. Add the repository-standard header before the label.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/source/device/add_device.rst` at line 1, Add the repository-standard
REUSE SPDX copyright and license header at the beginning of the documentation
file, before the device-interface-device-plugin Sphinx label. Preserve the
existing label and all following content unchanged.

Source: Coding guidelines