Updating Docs For Release

Streamlit release docs update

Follow these steps in order for each new Streamlit release (x.y.0).

Inputs

Require the target release version in major.minor.0 format (for example, 1.63.0). If the user did not provide it, ask before starting.

Derive the previous version from python/streamlit.json as the highest semantic version below the target version. Do not calculate it by subtracting one from the minor version. If the user explicitly provides a previous version, use it as an override after confirming that its key exists in python/streamlit.json.

State the target and previous versions before making changes.

1. Branch setup

Pull the latest main and create a release branch:

git checkout main && git pull origin main
git checkout -b docs/streamlit-x.y-release

2. Release notes

You need the release notes text. If the user hasn't provided them, ask them to run the generating-changelog skill in the streamlit/streamlit repo and paste the output here.

Two files to update:

content/develop/quick-references/release-notes/_index.md

• Replace the current ## **Version x.x.0 (latest)** section with the new release
• Keep the "Older versions" links section at the bottom unchanged

content/develop/quick-references/release-notes/<year>.md

• Prepend the new version section above the previous latest release

Format each section as:

## **Version x.y.0**

_Release date: Month D, YYYY_

**Highlights**
...

**Notable Changes**
...

**Other Changes**
...

Remove any duplicate bullets from the provided notes before adding them.

3. Docstring generation

Run python/generate.py in a clean virtualenv with the correct Streamlit version.

cd python
python3 -m venv .venv-generate
.venv-generate/bin/pip install -q streamlit docstring-parser docutils numpydoc
.venv-generate/bin/python -c "import streamlit; print(streamlit.__version__)"
.venv-generate/bin/python generate.py

Important:

• Always target the x.y.0 release key in streamlit.json, not patch releases (e.g. 1.59.0 not 1.59.2). After running, rename the key if pip installed a patch release: sed -i '' 's/"x.y.z":/"x.y.0":/' python/streamlit.json and do the same for GitHub source URLs in the blob links.
• If the script errors on a removed API (e.g. a deleted connection type), remove that entry from the obj_key dict in generate.py and re-run.
• Format streamlit.json with Prettier after generating: npx prettier --write python/streamlit.json
• Verify the diff: only a new "x.y.0" top-level key should appear — no existing version keys should be modified or removed. Check with: git diff python/streamlit.json | grep "^@@"— there should be exactly one hunk at the end of the file.

4. API tiles and pages

For each new command introduced in the release (not new parameters on existing commands), add a tile and detail page.

Detail page — create content/develop/api-reference/<section>/st.<command>.md:

---
title: st.<command>
slug: /develop/api-reference/<section>/st.<command>
description: <one-line description>
keywords: st.<command>, ...
---

<Autofunction function="streamlit.<command>" />

For column config types, use content/develop/api-reference/data/column_config/<name>.md with:

<Autofunction function="streamlit.column_config.<TypeName>" />

Tile — add to both:

1. The section's _index.md (e.g. content/develop/api-reference/status/_index.md)
2. The main content/develop/api-reference/_index.md

Tile format:

<RefCard href="/develop/api-reference/<section>/st.<command>">

<Image pure alt="screenshot" src="/images/api/<command>.jpg" />

<h4>Title</h4>

One-line description.

```python
st.<command>(...)
```

</RefCard>
```

Menu — add an entry in content/menu.md in the correct position.

Images — do not generate images. Ask the user to provide one, and point them to the Figma template file for reference: https://www.figma.com/design/MOGYWhaoD7OON4HsnbAT1z/API-illustrations?node-id=0-1&t=bs0XekxOUD8pO0to-1

Tell them the required format:

• Format: JPG
• Size: 862×862px for data/widget elements, 862×816px for status/layout elements (match the dimensions of a similar existing image in public/images/api/)
• They can also provide a PNG and you will convert it with: sips -s format jpeg input.png --out public/images/api/<name>.jpg

Place images at public/images/api/<name>.jpg.

5. Example apps

New demo apps can be added both for brand-new commands and for existing commands that gained a parameter (a new example is often added to demonstrate it). So check for newly added <Cloud name="..."> embeds across all commands, not just new ones.

The reliable way to find them is to diff the embedded Cloud names between the previous and new version keys in python/streamlit.json. For example:

cd python
.venv-generate/bin/python -c "
import json, re
d = json.load(open('streamlit.json'))
def cloud_names(ver):
    out = {}
    for k, v in d[ver].items():
        for field in ('example', 'examples'):
            for m in re.findall(r'<Cloud[^>]*name=\"([^\"]+)\"', v.get(field, '') or ''):
                out.setdefault(k, set()).add(m)
    return out
prev, new = cloud_names('x.y-1.0'), cloud_names('x.y.0')
for k, names in new.items():
    added = names - prev.get(k, set())
    if added:
        print(k, sorted(added))
"

Every embed printed is a new interactive app that needs to be deployed to Community Cloud.

For each new Cloud embed found:

1. Extract the name attribute (e.g. doc-mermaid-chart) — this is the required subdomain.
2. Extract the code from the adjacent <pre> block (strip HTML tags and unescape HTML entities).
3. Save the code to python/api-examples-source/<section>.<command_or_variant>.py following the existing naming convention (e.g. charts.mermaid_chart.py, status.skeleton_standalone.py).

After adding all files, present a table to the user:

The user will handle deploying the apps to Community Cloud.

6. Configuration options

After generating docstrings, compare Streamlit's live config with the docs. The source of truth is streamlit config show from the same virtualenv used in step 3:

cd python
.venv-generate/bin/python -c "import streamlit; print(streamlit.__version__)"
.venv-generate/bin/python -m streamlit config show

Primary file: content/develop/api-reference/configuration/config-toml.md

Diff the option keys and comments from streamlit config show against that page:

• Added options — copy the CLI description into the matching [section] TOML block, using the same comment style as neighboring options.
• Changed descriptions or defaults — update the existing comments (for example allowed values, inheritance rules, or default numbers).
• Removed options — delete them from config-toml.md. If other pages still mention the option (FAQs, theming guides, tutorials), update or remove those references too.

Do not paste every theme.light.* / theme.dark.* key as its own table. Document those as inheriting from [theme] (and [theme.sidebar] where applicable), and only list exceptions that cannot be set per light/dark/sidebar.

Related pages — if theme or server options changed, check whether these still match the CLI:

• content/develop/concepts/configuration/theming.md
• content/develop/concepts/configuration/theming-fonts.md
• content/develop/concepts/configuration/theming-colors-and-borders.md

Release-note bullets about client.*, server.*, runner.*, or theme.* are a useful hint for what moved, but streamlit config show is authoritative.

7. Removed and deprecated APIs

If this version removes or deprecates commands or parameters, update the current docs to match. Start from the release notes (removal and deprecation bullets) and confirm against the new python/streamlit.json key:

cd python
.venv-generate/bin/python -c "
import json
d = json.load(open('streamlit.json'))
prev, new = d['x.y-1.0'], d['x.y.0']
print('removed commands:', sorted(set(prev) - set(new)))
for k in sorted(set(prev) & set(new)):
    old_args = {a['name'] for a in (prev[k].get('args') or [])}
    new_args = {a['name'] for a in (new[k].get('args') or [])}
    gone = sorted(old_args - new_args)
    if gone:
        print(f'removed params on {k}:', gone)
"

Do not edit historical yearly release-note pages. Search content/ (skip content/develop/quick-references/release-notes/ except the current version) plus python/api-examples-source/, python/generate.py, content/menu.md, and content/develop/quick-references/api-cheat-sheet.md.

Deprecated (still in Streamlit)

Keep the API page. Mark it so readers see the replacement:

• On the detail page Autofunction: deprecated={true} and a deprecatedText that names the version and the replacement, for example:

<Autofunction function="streamlit.<command>" deprecated={true} deprecatedText="<code>st.<command></code> was deprecated in version x.y.0 and will be removed in a later version. Use <a href='/develop/api-reference/<section>/st.<replacement>'><code>st.<replacement></code></a> instead."/>

• Add deprecated to the page keywords.
• On the section _index.md RefCard: deprecated={true}. If the section already groups deprecated APIs (for example Deprecated classes), put the tile there.
• Parameter deprecations usually flow from docstrings (.. deprecated:: is parsed into streamlit.json). Still rewrite tutorials, cheat-sheet snippets, and extra examples that recommend the old parameter as current.