Read First
GuidesLink
In this section you can find various detailed guides to help you maintain code quality, enforce standards, and extend Sierra‑SDK through plugins.
-
Typing & Type Hints
Sierra‑SDK relies on static typing for clarity and safety. Learn how to configure and run MyPy (or Pyright), interpret errors, and leverage type hints effectively.
-
Linting & Formatting
Keep your codebase consistent and readable with Ruff linting rules and Black auto‑formatting. This guide shows you how to configure both tools and integrate them into your workflow.
-
Documentation & Docstring Standards
Generate and maintain clear API reference docs using MkDocs and mkdocstrings. Follow best practices for NumPy‑style docstrings to ensure your code is always well documented.
-
Plugin Development
Extend Sierra‑SDK’s functionality by writing custom plugins. Learn how to subclass the base plugin interface, register invokers, and structure your plugin for seamless integration.