Skip to content

docs: minor corrections #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 3, 2025
Merged

docs: minor corrections #37

merged 1 commit into from
Oct 3, 2025

Conversation

khromov
Copy link
Collaborator

@khromov khromov commented Oct 3, 2025

No description provided.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 3, 2025

⚠️ No Changeset found

Latest commit: 796c38e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Oct 3, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
mcp Ready Ready Preview Comment Oct 3, 2025 9:25pm

khromov
khromov commented Oct 3, 2025
View reviewed changes
documentation/docs/10-introduction/10-overview.md
The setup varies based on the version of the MCP you prefer — remote or local — and your chosen MCP client (e.g. Claude Code, Codex CLI or GitHub Copilot):

- [local setup](local-setup) using `@sveltejs/mcp`
- [remote setup](remote-setup) using [mcp.svelte.dev/mcp](https://mcp.svelte.dev/mcp)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Don't think this should be a link, even if it redirects to the MCP docs

@svelte-docs-bot
Copy link

Preview: https://svelte-dev-git-preview-mcp-37-svelte.vercel.app/

khromov
khromov commented Oct 3, 2025
View reviewed changes
documentation/docs/30-capabilities/30-prompts.md

## svelte-task

This prompt should be used whenever you are asking the model to work on some Svelte-related task. It will instruct the LLM on which documentation sections are available, which tool to invoke, when to invoke it, and how to interpret the result. It will ask you for the description of the task and the returned value will look like this:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't like putting the prompt verbatim in the docs, that's just asking to forget to update it. 😅 If we really want to we could link to the GitHub source code for the prompt.

@paoloricciuti paoloricciuti changed the title doc nits docs: minor corrections Oct 3, 2025
@khromov khromov requested a review from paoloricciuti October 3, 2025 21:31
paoloricciuti
paoloricciuti approved these changes Oct 3, 2025
View reviewed changes
Copy link
Member

@paoloricciuti paoloricciuti left a comment

Choose a reason for hiding this comment

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

Seems all reasonable suggestions!

@paoloricciuti paoloricciuti merged commit 7ada706 into main Oct 3, 2025
6 checks passed
@paoloricciuti paoloricciuti deleted the minor-text-fixes branch October 3, 2025 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@paoloricciuti paoloricciuti paoloricciuti approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@khromov @paoloricciuti