skills.rest
Opentrons
OpentronsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

docs

Guide MkDocs authoring and styling for Opentrons documentation.

515|208|Updated Jul 6, 2015
Search Tags:#documentation#markdown#macros#docs#frontmatter#mkdocs#mkdocstrings
One-click install
npx skills add https://github.com/Opentrons/opentrons --skill docs-opentrons
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Opentrons/opentrons/tree/main/.cursor/skills/docs
Command: npx skills add https://github.com/Opentrons/opentrons --skill docs-opentrons

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides authoring and styling guidelines for the Opentrons /docs MkDocs project, ensuring consistent structure, frontmatter usage, page titles, header IDs, image formats, tables, code blocks, and Python API references across publications.

Core Features & Use Cases

  • Directory structure and publication layout across multiple MkDocs projects, including docs/absorbance-plate-reader, docs/flex, docs/heater-shaker, docs/python-api, and others.
  • Shared content and resources in docs/shared (images, icons, theme overrides, CSS) to maintain site-wide consistency.
  • Tooling and config guidance for MkDocs builds, including docs/mkdocs.yml, monorepo plugin, and Python-based tooling like mkdocstrings, autorefs, and macros.

Quick Start

Apply the MkDocs authoring guidelines to create or edit docs in the /docs project.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure MkDocs documentation for multiple Opentrons publications?▼

MkDocs documentation for Opentrons uses a monorepo plugin to manage multiple publications like flex, python-api, and heater-shaker. Shared content and resources are stored in docs/shared to maintain site-wide consistency across builds.

What frontmatter and page conventions are required for the Opentrons docs project?▼

Opentrons documentation requires consistent frontmatter usage, page titles, header IDs, and image formats. These conventions ensure a cohesive knowledge base across all MkDocs publications and Python API references.

How do I configure mkdocstrings and macros plugins in mkdocs.yml?▼

The mkdocs.yml config enforces plugin usage for mkdocstrings, autorefs, and macros to build Python API references. These plugins work together to ensure a cohesive, reusable knowledge base across documentation projects.

Can I use shared images and CSS across different MkDocs projects in a monorepo?▼

Yes, shared content and resources like images, icons, theme overrides, and CSS are stored in docs/shared. This directory maintains site-wide consistency across multiple MkDocs publications.

What are the guidelines for formatting code blocks and tables in MkDocs?▼

MkDocs guidelines for Opentrons cover specific requirements for code blocks and tables. Consistent styling of these elements ensures documentation remains cohesive across all publications.

Does the Opentrons documentation project support Python API references with mkdocstrings?▼

Yes, the project uses mkdocstrings and autorefs plugins to generate Python API references. These tools enforce requirements within the mkdocs.yml config to ensure reusable documentation.

Related Skills

Explore More Content & Communication Skills→
digital-stoic-orgdigital-stoic-org
19

install-dependency

Automate monorepo-aware dependency installation across Python, JavaScript, and system packages.

Official
Intermediate
PelekePeleke

llms-txt-generator

Generate llms.txt and llms-full.txt files from MkDocs navigation and markdown content.

Community
Intermediate
oborchersoborchers
28

documentation

Structure technical documentation with MkDocs Material and the Diataxis framework.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced