update-docs-for-release

Update Streamlit documentation for new releases with branch creation and API generation.

177|702|Updated Jun 3, 2021
One-click install
npx skills add https://github.com/streamlit/docs --skill update-docs-for-release
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs-for-release
Source: https://github.com/streamlit/docs/tree/main/.cursor/skills/update-docs-for-release
Command: npx skills add https://github.com/streamlit/docs --skill update-docs-for-release

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires streamlit, docstring-parser, docutils, numpydoc.

What problem does it solve?

This skill automates the complex, multi-step process of updating documentation for new Streamlit releases, ensuring consistency across release notes, API references, and example applications.

Core Features & Use Cases

  • Automated Docstring Generation: Syncs API documentation directly from the Streamlit source code.
  • Release Workflow Management: Orchestrates branch creation, release note formatting, and API tile updates.
  • Example App Deployment: Facilitates the extraction and preparation of interactive cloud-hosted example apps for new features.

Quick Start

Initiate the update-docs-for-release skill to begin the documentation update process for the latest Streamlit version.

Frequently Asked Questions about update-docs-for-release

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

FAQPage Schema
How do I automate API documentation generation for a Python release?▼

Automate API documentation generation by running Python-based docstring generation scripts that parse source code using docstring-parser and numpydoc to synchronize API reference pages with the latest library version.

What is the best way to manage release notes and API tiles for Streamlit documentation?▼

Manage release notes and API tiles by orchestrating branch creation, formatting release notes, and updating API reference tiles to ensure documentation consistency across the streamlit/docs repository.

How does docstring parsing work for Streamlit API reference updates?▼

Docstring parsing extracts API documentation directly from Streamlit source code using docstring-parser and numpydoc dependencies, converting docstrings into formatted Markdown for API reference pages.

Can I use docutils and numpydoc to format Markdown documentation for Python libraries?▼

Yes, you can use docutils and numpydoc to format documentation by parsing Python docstrings and enforcing specific Markdown formatting standards required for documentation consistency during release updates.

Do I need to manually update interactive example apps for new Streamlit features?▼

You do not need to manually update example apps; the workflow facilitates the extraction and preparation of interactive cloud-hosted example applications for new features during the release process.

What are the limitations of automating documentation updates for software releases?▼

Limitations include strict adherence to specific Markdown formatting standards for documentation consistency and the requirement to execute Python-based docstring generation scripts targeting the streamlit/docs repository structure.