メニュー
RST documentation conventions for Scopy plugins including heading styles, toctree syntax, image placeholders, and attribute table format. Auto-loads when writing RST documentation for Scopy plugins.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Guidelines for using Context7, web search, and other research tools to find solutions outside the Scopy codebase. Loaded when the task involves unfamiliar technology or external libraries.
Core Scopy architecture knowledge including plugin lifecycle, library dependencies, build system, and key design patterns. Loaded by clarify-task and design-task commands.
How Scopy libraries depend on each other, plugin commonalities, MessageBroker topics, shared widgets, style system flow, and build system relationships. Loaded when determining component interactions or change impact.
Decision trees for common Scopy architectural choices - plugin vs core, tool vs section, widget type selection, sync vs async, GNU Radio vs direct, package organization, and API exposure. Loaded when making design decisions.
Catalog of all Scopy development tools including package generator, testing tools, CI scripts, format/license scripts, and dev plugin commands. Loaded when analyzing what tools exist for a task.
Code patterns and examples for Scopy IIOWidget unit tests. Covers standard helpers, data-driven testing, and complex multi-step scenarios. Auto-loads when creating or reviewing `*_Unit_test.js` files.
| name | scopy-doc-format |
| description | RST documentation conventions for Scopy plugins including heading styles, toctree syntax, image placeholders, and attribute table format. Auto-loads when writing RST documentation for Scopy plugins. |
Top-level title (80 = characters)
================================================================================
Section heading (dashes)
---------------------------------
Subsection heading (tildes)
~~~~~~~~~~~~~~~~~~
The underline must be at least as long as the heading text.
.. _<plugin>: # Main doc file
.. _<plugin>_index: # Index file
.. _<plugin>_advanced: # Advanced doc file
Labels must be unique across the entire documentation tree.
.. toctree::
:maxdepth: 2
<plugin>
<plugin>_advanced
.rst extension in toctree entriesDo NOT use .. figure:: or .. image:: directives. Use this comment format:
.. AN_IMAGE_WILL_BE_HERE
Screenshot: <exact description of what to capture>
e.g. "The RX Chain section showing hardware gain and sampling rate controls"
Place one placeholder:
- **Attribute Name:** One sentence description of what this attribute controls.
- **Another Attribute:** Description without wiki links.
.. _<plugin>_index:
<Device Name>
========================================
Overview
--------
<One paragraph about the plugin.>
Features
--------
- **Feature 1:** Description
Supported Devices
-------------------
- **<Device Family>** (list variants)
Getting Started
---------------
**Prerequisites**
- Hardware requirement
- Scopy version X.Y or later
.. toctree::
:maxdepth: 2
<plugin>
<plugin>_advanced
When adding a new plugin, update scopy/docs/plugins/index.rst: