Skip to content

[docs] Parallel fragments docs draft — handoff for streamlit/docs PR#15504

Draft
sfc-gh-lwilby-1 wants to merge 1 commit into
developfrom
docs/parallel-fragments-docs-draft
Draft

[docs] Parallel fragments docs draft — handoff for streamlit/docs PR#15504
sfc-gh-lwilby-1 wants to merge 1 commit into
developfrom
docs/parallel-fragments-docs-draft

Conversation

@sfc-gh-lwilby-1

Copy link
Copy Markdown
Contributor

Describe your changes

Draft documentation for the parallel=True parameter on @st.fragment, intended as a reference/handoff for a contributor to submit as a PR to streamlit/docs.

This PR contains a single markdown file with proposed changes to 5 pages in the docs repo:

  1. Concepts page (fragments.md) — new "Run fragments in parallel" section, thread safety guidance, restricted commands, plus updates to use cases, execution flow, limitations, and run_every interaction
  2. API reference (fragment.md) — SEO keyword additions (parallel, concurrency)
  3. New tutorial — "Speed up your app with parallel fragments" — full step-by-step walkthrough
  4. Menu — new tutorial entry under Execution flow / Fragments
  5. Release notes — verified already covered (no change needed)

For the contributor

The draft is AI-generated and needs human polish before submitting to streamlit/docs. Key suggested tasks:

  • Run the tutorial code end-to-end and verify every step works
  • Rewrite prose in your own voice to match the Streamlit docs tone
  • Verify version number (1.58.0) and all internal doc slugs
  • Add screenshots/GIFs (the existing fragment tutorials have them)
  • Confirm callout tag style (<Tip>, <Warning>, <Note>) with the docs team
  • Check if a runnable example source should be added under python/api-examples-source/

Testing Plan

  • No tests needed — this is a documentation reference file, not a code change.

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

@sfc-gh-lwilby-1 sfc-gh-lwilby-1 added change:docs PR contains documentation change impact:internal PR changes only affect internal code labels Jun 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🚧 PR preview is building...

Name Link
📦 Wheel file Building...
📦 @streamlit/component-v2-lib Building...
🕹️ Preview app Building...

@sfc-gh-lwilby-1 sfc-gh-lwilby-1 added the do-not-merge PR is blocked from merging label Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

change:docs PR contains documentation change do-not-merge PR is blocked from merging impact:internal PR changes only affect internal code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant