Skip to content

Docs: Add instructions for Github Pages deployment #7786

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

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

Conversation

davidde
Copy link

@davidde davidde commented Aug 6, 2025

What is it?

Docs

Description

As it stands, generating a Qwik static site is a very complicated process with very little documentation. This PR gives a standard workflow using Github Pages deployment as an example.

This mini-tutorial could also be moved to a different section. I placed it inside the existing tutorial because it elaborates on getting the tutorial deployed.

Checklist

  • My code follows the developer guidelines of this project
  • I performed a self-review of my own code
  • I added a changeset with pnpm change
  • I made corresponding changes to the Qwik docs
  • I added new tests to cover the fix / functionality

@davidde davidde requested a review from a team as a code owner August 6, 2025 14:08
Copy link

changeset-bot bot commented Aug 6, 2025

⚠️ No Changeset found

Latest commit: 7e35fc6

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

Copy link
Contributor

github-actions bot commented Aug 6, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
qwik-docs ✅ Ready (View Log) Visit Preview b9dac86

Copy link
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

Thanks for your help @davidde
Can we create a new section here for GitHub Pages?

Image

@davidde
Copy link
Author

davidde commented Aug 6, 2025

Yeah sure, looks great to me! 👍

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.

[📖] Better docs required for static site generation (e.g. for Github Pages)
2 participants