docs: sync docs/skill/README/CLAUDE to magic_devtools extraction + artisan ^0.0.8#17
Merged
Merged
Conversation
…tisan ^0.0.8 The 0.0.4 install-command change (repoint to package:magic_devtools/ telescope.dart, gate on the magic_devtools dependency) and the artisan ^0.0.6 -> ^0.0.8 bump were not reflected in the docs/skill/README/CLAUDE. Bring them in line (Golden Rules 1/2/4): - doc/watchers: the 5 Magic watchers + MagicTelescopeIntegration ship in magic_devtools, not magic core; registration snippets import package:magic_devtools/telescope.dart. - installation/quickstart/index/mcp-setup: magic_devtools dev_dependency + import; install command gates on magic_devtools, not magic. - README quick-start snippet + Magic Integration row. - SKILL.md + cli-commands/workflows/community references. - CLAUDE.md + copilot-instructions: fluttersdk_artisan ^0.0.8. - CHANGELOG: fold the [Unreleased] install fixes into [0.0.4] (they ship in the 0.0.4 tag) and add a Documentation entry for this sync.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR synchronizes Telescope’s documentation/skill guidance with the already-merged magic_devtools extraction (moving MagicTelescopeIntegration out of magic core) and with the fluttersdk_artisan ^0.0.8 constraint bump, so the public guidance matches current master behavior ahead of tagging 0.0.4.
Changes:
- Update docs/snippets to reference
magic_devtools(package:magic_devtools/telescope.dart) for Magic-stack integration and installation gating. - Refresh skill references and README language to match the updated install behavior and dependency gate.
- Update CLAUDE/Copilot instructions and CHANGELOG entries to reflect the
fluttersdk_artisan ^0.0.8bump and document the doc-sync work.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/fluttersdk-telescope/SKILL.md | Updates skill guidance to attribute Magic integration to magic_devtools and adjusts install snippet narrative. |
| skills/fluttersdk-telescope/references/workflows.md | Updates workflow guidance to reference magic_devtools import for MagicTelescopeIntegration. |
| skills/fluttersdk-telescope/references/community.md | Updates community triage notes to attribute MagicTelescopeIntegration to magic_devtools. |
| skills/fluttersdk-telescope/references/cli-commands.md | Updates CLI install behavior description to gate on magic_devtools and inject the new import. |
| README.md | Updates Magic integration description and quickstart snippet to reference magic_devtools. |
| doc/watchers/index.md | Updates watcher docs to state Magic watchers ship in magic_devtools and adds per-watcher “Package” rows/snippets. |
| doc/mcp/setup.md | Updates MCP setup snippet to include magic_devtools import and Magic integration block guidance. |
| doc/getting-started/quickstart.md | Updates install output and narrative to reference magic_devtools gating/import and Magic extraction. |
| doc/getting-started/installation.md | Updates installation steps to describe magic_devtools-gated patching and adds Magic dev_dependency guidance. |
| doc/getting-started/index.md | Updates getting-started index to reference Magic integration coming from magic_devtools. |
| CLAUDE.md | Updates documented stack/dependency constraint to fluttersdk_artisan ^0.0.8. |
| CHANGELOG.md | Moves already-shipped install fixes into the 0.0.4 section and adds a documentation sync entry. |
| .github/copilot-instructions.md | Mirrors CLAUDE stack doc update to fluttersdk_artisan ^0.0.8. |
| ```dart | ||
| import 'package:flutter/foundation.dart'; | ||
| import 'package:fluttersdk_telescope/telescope.dart'; | ||
| import 'package:magic_devtools/telescope.dart'; // magic_devtools dev_dependency (Magic-stack apps only) |
Comment on lines
46
to
50
| ```dart | ||
| import 'package:flutter/foundation.dart'; | ||
| import 'package:fluttersdk_telescope/telescope.dart'; | ||
| import 'package:magic_devtools/telescope.dart'; // magic_devtools dev_dependency (Magic-stack apps only) | ||
|
|
Comment on lines
241
to
242
| @@ -240,6 +242,8 @@ dart run fluttersdk_telescope telescope:install | |||
| by `if (kDebugMode)` so release builds tree-shake the entire block: | |||
…y Magic-stack inject (PR #17 review) Address Copilot review on PR #17: - README / installation / quickstart / mcp-setup: fluttersdk_telescope pin ^0.0.3 -> ^0.0.4 to match the version being tagged. - SKILL.md: frontmatter version + stamp -> 0.0.4 (2026-06-17); clarify that the magic_devtools import + MagicTelescopeIntegration block is injected only for Magic-stack projects (magic_devtools dep + Magic.init anchor), vanilla apps get only the TelescopePlugin block. - CHANGELOG [0.0.4] Documentation entry notes the pin bump.
Contributor
Author
|
Addressed all five Copilot review notes in 4e51ca5:
Verified: |
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.
Brings telescope's docs, skill, README, and CLAUDE in line with two changes already on master that weren't doc-synced (Golden Rules 1/2/4): the
telescope:installrepoint topackage:magic_devtools/telescope.dart(+ themagic_devtoolsdependency gate) and thefluttersdk_artisan ^0.0.6 -> ^0.0.8bump.Changes
MagicTelescopeIntegration+MagicHttpFacadeAdaptership inmagic_devtools, not magic core; registration snippets importpackage:magic_devtools/telescope.dart; each watcher table gains aPackagerow.magic_devtools(notmagic) and injects the magic_devtools import.magic:->magic_devtools:, injected import line, magic_devtools attribution.fluttersdk_artisan ^0.0.8.[Unreleased]install fixes into[0.0.4](they ship in the 0.0.4 tag) + add aDocumentationentry.No code/test/pubspec changes. Verified:
dart analyze0,dart formatclean,flutter test254 green, nopackage:magic/telescope_integrationor staleartisan ^0.0.6left in current docs.Land before tagging 0.0.4.