Skip to content

Doc: Expand plugs and slots exp, how-tos#820

Open
akcano wants to merge 6 commits into
mainfrom
docs/plugs-and-slots
Open

Doc: Expand plugs and slots exp, how-tos#820
akcano wants to merge 6 commits into
mainfrom
docs/plugs-and-slots

Conversation

@akcano

@akcano akcano commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands Workshop’s documentation around interface topology (plugs/slots, autowiring, and explicit wiring) by adding new explanation + how-to pages, updating existing interface docs for clarity, and introducing spread tasks to keep the new how-tos operational end-to-end.

Changes:

  • Add new documentation pages: Plugs and slots (explanation), Declare plugs and slots (how-to), and Design the interface layout (how-to).
  • Update interface concepts/tunnel docs and navigation (toctrees + redirects + custom wordlist).
  • Add spread tests that exercise the new how-to workflows (sdkcraft pack verification; explicit mount connections + grafting).

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/docs-how-to/design-interface-layout/task.yaml Spread task to validate explicit connections, runtime rewiring, and grafted plugs behave as documented
tests/docs-how-to/design-interface-layout/dev.yaml Workshop definition used for the “no explicit connections” stage
tests/docs-how-to/design-interface-layout/dev.connected.yaml Workshop definition variant adding an explicit plug→slot connection
tests/docs-how-to/design-interface-layout/.workshop/provider-b/sdk.yaml Local in-project SDK providing an additional mount slot for ambiguity scenarios
tests/docs-how-to/design-interface-layout/.workshop/provider-b/hooks/setup-base Creates provider-b’s exported directory + marker used by the test
tests/docs-how-to/design-interface-layout/.workshop/provider-a/sdk.yaml Local in-project SDK providing the primary mount slot
tests/docs-how-to/design-interface-layout/.workshop/provider-a/hooks/setup-base Creates provider-a’s exported directory + marker used by the test
tests/docs-how-to/design-interface-layout/.workshop/plainconsumer/sdk.yaml Consumer SDK with no plug (for grafting scenario)
tests/docs-how-to/design-interface-layout/.workshop/graft.yaml Workshop definition demonstrating plug grafting and explicit wiring
tests/docs-how-to/design-interface-layout/.workshop/consumer/sdk.yaml Consumer SDK defining a mount plug used in explicit wiring scenarios
tests/docs-how-to/declare-plugs-slots/task.yaml Spread task to verify plugs/slots declarations are preserved into packed SDK metadata
tests/docs-how-to/declare-plugs-slots/sdkcraft.yaml Example sdkcraft.yaml used by the how-to + test
docs/redirects.txt Redirect legacy how-to URL to the new design-interface-layout page
docs/how-to/develop-sdks/index.rst Add the new “Declare plugs and slots” how-to to the develop-SDKs toctree
docs/how-to/develop-sdks/declare-plugs-slots.rst New how-to describing mount/tunnel plugs+slots and validation via sdkcraft pack
docs/how-to/customize-workshops/index.rst Add the new “Design the interface layout” how-to to the customize-workshops toctree
docs/how-to/customize-workshops/design-interface-layout.rst New how-to explaining explicit connections, grafting plugs, and runtime rewiring
docs/explanation/interfaces/tunnel-interface.rst Clarify tunnel auto-connect policy wording (loopback vs localhost-only)
docs/explanation/interfaces/plugs-and-slots.rst New explanation page detailing plugs/slots, autowiring, bindings, and connections
docs/explanation/interfaces/index.rst Add “plugs-and-slots” to the interfaces explanation index
docs/explanation/interfaces/concepts.rst Refactor plugs/slots content into the new page and summarize tunnel interface behavior
docs/.custom_wordlist.txt Add “autowiring” and “loopback” for docs spellchecking

Comment thread docs/explanation/interfaces/concepts.rst Outdated
@akcano akcano force-pushed the docs/plugs-and-slots branch from 147a83d to 293ac58 Compare June 3, 2026 20:34
@akcano akcano force-pushed the docs/plugs-and-slots branch from 293ac58 to 28b6c9e Compare June 9, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants