Skip to content

update C3 instructions for Pages projects #22005

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

Merged
merged 1 commit into from
Apr 29, 2025

Conversation

petebacondarwin
Copy link
Contributor

Summary

It is now required to pass --platform=pages to create a Pages project.

Screenshots (optional)

Documentation checklist

Copy link
Contributor

hyperlint-ai bot commented Apr 28, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated C3 instructions to require the --platform=pages argument for creating Pages projects.

  • Modified C3 command examples to include --platform=pages for npm, yarn, and pnpm.
  • Added a note emphasizing the requirement of the --platform=pages argument to create a Pages project.

Modified Files

  • src/content/docs/pages/get-started/c3.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@petebacondarwin petebacondarwin force-pushed the pbd/c3/update-pages-instructions branch from 0ea6737 to 5cb32a2 Compare April 28, 2025 07:25
@petebacondarwin petebacondarwin requested review from mikenomitch and a team as code owners April 28, 2025 07:25
It is now required to pass `--platform=pages` to create a Pages project.
@petebacondarwin petebacondarwin force-pushed the pbd/c3/update-pages-instructions branch from 5cb32a2 to 532183e Compare April 28, 2025 07:27
@lrapoport-cf
Copy link
Contributor

@petebacondarwin thanks for putting this up! can you add the --platform flag into the CLI arguments section as well?

@petebacondarwin
Copy link
Contributor Author

@petebacondarwin thanks for putting this up! can you add the --platform flag into the CLI arguments section as well?

Is that actually the right thing to do here?

The only options for --platform are pages and workers. But this doc is in the Pages section of the docs and is specifically about running C3 to generate a Pages project; and in the snippets I have hard coded the --platform=pages option.

@lrapoport-cf
Copy link
Contributor

@petebacondarwin thanks for putting this up! can you add the --platform flag into the CLI arguments section as well?

Is that actually the right thing to do here?

The only options for --platform are pages and workers. But this doc is in the Pages section of the docs and is specifically about running C3 to generate a Pages project; and in the snippets I have hard coded the --platform=pages option.

hmm, good question. the CLI arguments being listed in this section conflates pages-specific concerns with more general c3 documentation, especially given the wording:
image

we might want to consider reorganizing some of the c3 documentation, but that's not within the scope of this PR, so we can table my comment for now and revisit later if makes sense

Copy link
Contributor

Choose a reason for hiding this comment

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

Should this just be inlined? Why is it a partial?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No idea. I guess the original plan was that it would be reused for Pages and Workers?

@petebacondarwin petebacondarwin merged commit de71097 into production Apr 29, 2025
13 checks passed
@petebacondarwin petebacondarwin deleted the pbd/c3/update-pages-instructions branch April 29, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.