feat: surface module docs

[Julusian]

Summary by CodeRabbit

• Documentation
  • Added comprehensive Surface Development documentation section for developers building control surfaces, including guides on discovery, lifecycle, layout, rendering, input handling, and locking.
  • Reorganized Module Development documentation under "Connection Development" terminology.
  • Added advanced surface topics covering custom discovery flows and firmware updates.
  • Added surface debugging guidance for developers.

[coderabbitai]

Warning

Review limit reached

@Julusian, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 58 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b748af16-fa5d-4f3c-bd6d-9ea483c3ae52

📥 Commits

Reviewing files that changed from the base of the PR and between a268777 and b4d2106.

📒 Files selected for processing (3)

• for-developers/surface-development/surface-advanced/custom-discovery.md
• for-developers/surface-development/surface-basics/layout.md
• for-developers/surface-development/surface-basics/overview.md

📝 Walkthrough

Walkthrough

The PR renames the existing "Module Development" documentation section to "Connection Development" (updating labels, titles, and sidebar positions), and introduces a new "Surface Development" section with a full set of developer guide pages covering the SurfacePlugin model, lifecycle, discovery flows, surface instance API, layout, rendering, input, locking, advanced custom discovery, firmware update reporting, and debugging guidance.

Changes

Connection Development Rename + New Surface Development Docs

Layer / File(s)	Summary
Connection Development rename and sidebar reordering for-developers/core-development/_category_.json, for-developers/maintenance-team/_category_.json, for-developers/module-development/_category_.json, for-developers/module-development/home.md, for-developers/module-development/index.md	Renames the module-development category to "Connection Development", updates home and index pages with connection-specific terminology and a pointer to the new Surface Development section, and increments sidebar positions of adjacent categories to make room.
Surface Development category and entry pages for-developers/surface-development/_category_.json, for-developers/surface-development/index.md, for-developers/surface-development/home.md	Adds the top-level "Surface Development" category configuration and its landing pages: an index overview and a "Getting Started with Surfaces" page covering shared setup steps, surface-specific responsibilities, reference links, and a Slack contact.
Surface Basics: plugin model, lifecycle, and discovery for-developers/surface-development/surface-basics/_category_.json, for-developers/surface-development/surface-basics/index.md, for-developers/surface-development/surface-basics/overview.md, for-developers/surface-development/surface-basics/lifecycle.md, for-developers/surface-development/surface-basics/discovery.md	Adds the Surfaces: Basics category and its core conceptual pages: SurfacePlugin overview (TInfo generic, openSurface, SurfaceContext, manifest), plugin lifecycle (init/destroy and event-emission constraints), and discovery flows (USB HID via checkSupportsHidDevice, remote/network via SurfacePluginRemote, and a comparison table).
Surface Basics: instance API, layout, rendering, input, and locking for-developers/surface-development/surface-basics/the-surface-instance.md, for-developers/surface-development/surface-basics/layout.md, for-developers/surface-development/surface-basics/rendering.md, for-developers/surface-development/surface-basics/input.md, for-developers/surface-development/surface-basics/locking-and-pincode.md	Documents the per-device surface instance contract, surfaceLayout declaration (style presets, bitmap format, control map), the draw/setBrightness/blank rendering API, input reporting via SurfaceContext (button/encoder events, page changes, transfer variables), and locking/pincode entry via pincodeMap and showLockedStatus.
Surface Advanced topics and debugging for-developers/surface-development/surface-advanced/_category_.json, for-developers/surface-development/surface-advanced/index.md, for-developers/surface-development/surface-advanced/custom-discovery.md, for-developers/surface-development/surface-advanced/firmware-updates.md, for-developers/surface-development/surface-debugging.md	Adds the Surfaces: Advanced category with pages on custom discovery (active scanForSurfaces and plugin-owned SurfacePluginDetection), firmware update reporting via checkForFirmwareUpdates and SurfaceFirmwareUpdateCache, and a debugging page cross-linked to the connection-module debugging guide.

Poem

🎛️ A surface awakens, connects to the show,
Buttons and encoders all ready to glow.
The docs found a home in a brand-new section,
Modules renamed with care and affection.
From init() to draw(), the path is now clear —
Welcome, Surface Developer, we're glad you're here! 🚀

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: surface module docs' clearly and directly summarizes the main change—adding comprehensive surface module documentation to the repository.
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.}

---

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

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

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

for-developers/surface-development/surface-basics/overview.md (1)

1-82: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Run Prettier to fix formatting warnings.

The GitHub Actions pipeline caught a Prettier formatting issue. A quick fix: run prettier --write on this file to match the project's code style, then commit the changes.

Source: Pipeline failures

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ed6a4a80-c984-40b7-9d84-dbebdce7e0ad

📥 Commits

Reviewing files that changed from the base of the PR and between 3168351 and a268777.

📒 Files selected for processing (23)

• for-developers/core-development/_category_.json
• for-developers/maintenance-team/_category_.json
• for-developers/module-development/_category_.json
• for-developers/module-development/home.md
• for-developers/module-development/index.md
• for-developers/surface-development/_category_.json
• for-developers/surface-development/home.md
• for-developers/surface-development/index.md
• for-developers/surface-development/surface-advanced/_category_.json
• for-developers/surface-development/surface-advanced/custom-discovery.md
• for-developers/surface-development/surface-advanced/firmware-updates.md
• for-developers/surface-development/surface-advanced/index.md
• for-developers/surface-development/surface-basics/_category_.json
• for-developers/surface-development/surface-basics/discovery.md
• for-developers/surface-development/surface-basics/index.md
• for-developers/surface-development/surface-basics/input.md
• for-developers/surface-development/surface-basics/layout.md
• for-developers/surface-development/surface-basics/lifecycle.md
• for-developers/surface-development/surface-basics/locking-and-pincode.md
• for-developers/surface-development/surface-basics/overview.md
• for-developers/surface-development/surface-basics/rendering.md
• for-developers/surface-development/surface-basics/the-surface-instance.md
• for-developers/surface-development/surface-debugging.md