Skip to content

Split and organize SwitchBot API v1.1 documentation by device#472

Open
hsakoh wants to merge 1 commit into
OpenWonderLabs:mainfrom
hsakoh:feature/split_by_device
Open

Split and organize SwitchBot API v1.1 documentation by device#472
hsakoh wants to merge 1 commit into
OpenWonderLabs:mainfrom
hsakoh:feature/split_by_device

Conversation

@hsakoh
Copy link
Copy Markdown
Contributor

@hsakoh hsakoh commented Mar 6, 2026

Overview

Restructured the large SwitchBot API v1.1 specification into a modular, device-specific and categorized document structure.

Key Changes

  • Document Splitting: Decomposed monolithic spec into 75 device-specific + 1 common documentation files
  • Category Organization: Introduced 12-category folder structure (locks-security, lighting, climate-control, etc.)

Benefits

  • Maintainability: Modular structure makes updates easier
  • Searchability: Device-specific files enable quick information retrieval
  • Scalability: Auto-classification & categorization for new devices

Is this approach acceptable?

For a visual preview, please check the branch directly.

@hsakoh
Copy link
Copy Markdown
Contributor Author

hsakoh commented Apr 17, 2026

@Minsheng
Could you please take a look at this PR when you have time?

@hsakoh hsakoh force-pushed the feature/split_by_device branch from 952077d to 8ba15c3 Compare May 16, 2026 03:40
@hsakoh
Copy link
Copy Markdown
Contributor Author

hsakoh commented May 16, 2026

I have rebased onto the latest main (commit 0214825) and force-pushed this branch to incorporate the four newly added devices:

  • Weather Station — device list, status, control commands, and webhook events
  • Lock Pro Matter Enabled — device list (with status JSON example), status, control commands (lock, unlock, nightLatchUnlock, deadbolt), and webhook events
  • Lock Vision — device list (with passcode keyList), status, control commands (lock, unlock, createKey, deleteKey), and webhook events
  • Lock Vision Pro — same structure as Lock Vision

Each device has been split into its own dedicated Markdown file following the same structure as the existing device pages, and the Glossary and Device Specifications table in README.md have been updated accordingly.

@hsakoh hsakoh force-pushed the feature/split_by_device branch from 8ba15c3 to e36d61b Compare May 16, 2026 03:52
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.

3 participants