René's URL Explorer Experiment


Title: docs: Per-parameter configuration reference, generated from a config schema · Issue #1050 · tmux-python/tmuxp · GitHub

Open Graph Title: docs: Per-parameter configuration reference, generated from a config schema · Issue #1050 · tmux-python/tmuxp

X Title: docs: Per-parameter configuration reference, generated from a config schema · Issue #1050 · tmux-python/tmuxp

Description: Problem Workspace configuration keys are documented as narrative sections in docs/configuration/top-level.md and docs/configuration/examples.md. That shape has three costs: No linkable per-parameter target. Issues, PRs, CHANGES entries, ...

Open Graph Description: Problem Workspace configuration keys are documented as narrative sections in docs/configuration/top-level.md and docs/configuration/examples.md. That shape has three costs: No linkable per-paramete...

X Description: Problem Workspace configuration keys are documented as narrative sections in docs/configuration/top-level.md and docs/configuration/examples.md. That shape has three costs: No linkable per-paramete...

Opengraph URL: https://github.com/tmux-python/tmuxp/issues/1050

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"docs: Per-parameter configuration reference, generated from a config schema","articleBody":"## Problem\n\nWorkspace configuration keys are documented as narrative sections in `docs/configuration/top-level.md` and `docs/configuration/examples.md`. That shape has three costs:\n\n- **No linkable per-parameter target.** Issues, PRs, CHANGES entries, and warnings can't point at \"the `synchronize` reference\" — only at a whole page.\n- **No canonical inventory.** The set of valid keys lives implicitly across `loader.expand()`, `loader.trickle()`, `validation.validate_schema()`, and the builder. Discovering \"what can I put in a workspace file, at which level, with what default?\" requires reading source.\n- **Drift risk.** Prose and code are updated separately; the parity work (#1016, #1047–#1049) is adding many new keys (pane titles, `synchronize`, `shell_command_after`, `clear`, lifecycle hooks), which multiplies both the value of a reference and the surface for drift.\n\n## Proposal\n\n### 1. Per-parameter reference pages\n\nOne page (or one anchored section) per config parameter, each carrying:\n\n- Name, **level** (session / window / pane), type, default\n- Version introduced\n- 1–3 prose paragraphs of behavior\n- At least one copy-paste workspace example\n- Related keys / interactions (e.g. `synchronize: after` vs `shell_command_after` ordering)\n\nPlus an index table grouped by level, so the full vocabulary is scannable on one screen.\n\n### 2. Bonus: make them autodocumentable\n\nThe drift problem disappears if docs and validation share one source of truth. Sketch:\n\n1. **Declarative schema registry in code** — a dataclass (or table of records) describing every key: name, level, type, default, since-version, help text, example. `loader`/`validation` consume it instead of hardcoding key knowledge; `validate_schema()` becomes data-driven.\n2. **Sphinx directive that renders the registry** — prior art is exactly this pattern:\n   - **myst-parser** documents `MdParserConfig` by introspecting its dataclass fields and `field.metadata[\"help\"]` via a custom `MystConfigDirective`, invoked in docs as a `{myst-config}` fenced directive (`myst_parser/_docs.py`). tmuxp can do the same with a `{tmuxp-config}` directive filterable by level.\n   - **Sphinx core** documents its own options with the `confval` directive, which yields stable cross-referenceable targets (`{confval}` role) — adopting `confval`-style object types gives every parameter a permalink usable from CHANGES and warnings.\n3. The generic directive could live in tmuxp's docs `conf.py` initially; if it proves reusable, graduating it to the shared docs platform (gp-sphinx) is a natural follow-up.\n\n### Phasing\n\n1. **Inventory + anchors** — enumerate every key from loader/validation/builder, restructure existing prose under per-key anchors, add the index table. Docs-only, no code changes.\n2. **Schema registry** — introduce the declarative registry; port `validate_schema()` and loader key-handling onto it; doctest the registry.\n3. **Directive** — render per-key reference docs from the registry; delete the now-duplicated hand-written tables; CI ensures a key without registry metadata fails the build.\n\n### Acceptance criteria\n\n- Every workspace config key has a linkable reference target with level, type, default, and a working example\n- The key inventory in docs is generated from (or validated against) the same structure the loader/validator uses\n- Adding a new config key without docs metadata fails loudly (build or test)\n\nRefs #1016 (the parity effort expanding the config surface this would document).","author":{"url":"https://github.com/tony","@type":"Person","name":"tony"},"datePublished":"2026-06-07T14:22:50Z","url":"https://github.com/tmux-python/tmuxp/issues/1050"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:06946717-2b6e-f660-5aab-b4a8cda3ce58
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB70E:2FA100:4E886:6E37A:6B007E53
html-safe-nonceecb32328ac736a8d33790717e528ed545020a5127a6abc4076dc6a9d2956a4c9
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNzBFOjJGQTEwMDo0RTg4Njo2RTM3QTo2QjAwN0U1MyIsInZpc2l0b3JfaWQiOiIxOTYwNDAxNzE2MjY0MzM2OTc5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac601d028ff1c7b4fc431f4ba050a9ebe79c3d93e741e92b7e7771f8372b99a0f3
hovercard-subject-tagissue:4607621373
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/tmux-python/tmuxp/1050/issue_layout
twitter:imagehttps://opengraph.githubassets.com/e64724d048437674c73a6a527f0a23466f6414ac17fb962d6d40bd366701aa9e/tmux-python/tmuxp/issues/1050
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/e64724d048437674c73a6a527f0a23466f6414ac17fb962d6d40bd366701aa9e/tmux-python/tmuxp/issues/1050
og:image:altProblem Workspace configuration keys are documented as narrative sections in docs/configuration/top-level.md and docs/configuration/examples.md. That shape has three costs: No linkable per-paramete...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernametony
hostnamegithub.com
expected-hostnamegithub.com
None82c186f13e104004ab7bdb779f3195e59dd38bfde531aaa74b76470fc2462b83
turbo-cache-controlno-preview
go-importgithub.com/tmux-python/tmuxp git https://github.com/tmux-python/tmuxp.git
octolytics-dimension-user_id37234308
octolytics-dimension-user_logintmux-python
octolytics-dimension-repository_id12398170
octolytics-dimension-repository_nwotmux-python/tmuxp
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id12398170
octolytics-dimension-repository_network_root_nwotmux-python/tmuxp
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
released1bc2aa1939001689f5ce935982c10a6138f745c
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/tmux-python/tmuxp/issues/1050#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftmux-python%2Ftmuxp%2Fissues%2F1050
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Ftmux-python%2Ftmuxp%2Fissues%2F1050
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=tmux-python%2Ftmuxp
Reloadhttps://github.com/tmux-python/tmuxp/issues/1050
Reloadhttps://github.com/tmux-python/tmuxp/issues/1050
Reloadhttps://github.com/tmux-python/tmuxp/issues/1050
tmux-pythonhttps://github.com/tmux-python
tmuxphttps://github.com/tmux-python/tmuxp
Codehttps://github.com/tmux-python/tmuxp
Issues113 (113)https://github.com/tmux-python/tmuxp/issues
Pull requests29 (29)https://github.com/tmux-python/tmuxp/pulls
Discussionshttps://github.com/tmux-python/tmuxp/discussions
Actionshttps://github.com/tmux-python/tmuxp/actions
Security and qualityhttps://github.com/tmux-python/tmuxp/security
Insightshttps://github.com/tmux-python/tmuxp/insights
https://github.com/tmux-python/tmuxp
New issuehttps://github.com/login?return_to=https://github.com/tmux-python/tmuxp/issues/1050
New issuehttps://github.com/login?return_to=https://github.com/tmux-python/tmuxp/issues/1050
docs: Per-parameter configuration reference, generated from a config schemahttps://github.com/tmux-python/tmuxp/issues/1050#top
https://github.com/tony
tonyhttps://github.com/tony
on Jun 7, 2026https://github.com/tmux-python/tmuxp/issues/1050#issue-4607621373
tmuxinator/teamocil feature parity #1016https://github.com/tmux-python/tmuxp/issues/1016
Workspace(feat[runtime]): Add pane title and synchronization keys #1047https://github.com/tmux-python/tmuxp/pull/1047
Workspace(feat[importers]): Add tmuxinator and teamocil parity fallbacks #1049https://github.com/tmux-python/tmuxp/pull/1049
#1016https://github.com/tmux-python/tmuxp/issues/1016
Sign up for freehttps://github.com/signup?return_to=https://github.com/tmux-python/tmuxp/issues/1050
Sign in to commenthttps://github.com/login?return_to=https://github.com/tmux-python/tmuxp/issues/1050
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.