Add documentation for views as setup assistants - #33
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds and cross-links documentation for “view-based” setup assistants (using packaged views instead of declarative field lists), including how this.completeSetup() persists setup config and what behavioral/validation gotchas apply.
Changes:
- Document view-based setup assistants end-to-end (manifest keys, host-provided chrome, save semantics, packaging validation).
- Add/expand
this.completeSetup(payload, options?)docs and reference it as the preferred way to write setup config from scripts. - Update related indexes/glossary/gotchas and refresh referenced engine version text.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/README.md | Updates the docs index entry to reflect the new view-based setup-assistant content. |
| docs/method-index.md | Adds this.completeSetup and view-based assistant entries; updates section anchors. |
| docs/glossary.md | Expands setup-assistant terminology and adds “View-based setup assistant” definition. |
| docs/17-gotchas.md | Adds multiple gotchas specific to completeSetup and view-based assistants. |
| docs/16-release-and-publish.md | Notes packager-version dependency for validating assistant view rules. |
| docs/13-setup-assistants.md | Adds the full “View-based setup assistants” section and renumbers downstream sections. |
| docs/05-platform-api.md | Recommends this.completeSetup() for writing setup config vs wholesale PATCH. |
| docs/04-worker-runtime-api.md | Documents this.completeSetup() and updates calendar-source restrictions. |
| docs/03-manifest-reference.md | Adds setup_assistant.view / user_setup_assistant.view and validation rules. |
| docs/02-getting-started.md | Clarifies local viewer/validation limitations for view-based setup assistants. |
| docs/01-overview.md | Updates overview narrative to include view-based assistants and completeSetup. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.