Skip to content
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.

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

docs: add note for gh-pages cli to adapter static docs #13309

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ghostdevv
Copy link
Member

#13302 seemed to break, so re-opened it here with suggestions applied


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Jan 14, 2025

⚠️ No Changeset found

Latest commit: 5169836

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

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-kit-13309-svelte.vercel.app/

this is an automated message

Copy link
Member

@benmccann benmccann left a comment

Choose a reason for hiding this comment

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

I'm not sure we should be adding docs for third-party tools to our docs. tschaub/gh-pages isn't an official package and I think the docs would become messy quickly if we had to document every third-party client

@ghostdevv
Copy link
Member Author

I'm not sure we should be adding docs for third-party tools to our docs. tschaub/gh-pages isn't an official package and I think the docs would become messy quickly if we had to document every third-party client

I was going to say the same thing too. However, I changed my mind because I can't imagine there would be a litany of these to add, and it might save someone some time or frustration if they're using this tool. Generally, I think that documenting more cases is helpful and this tool seems to have decent usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pkg:adapter-static
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants