Skip to content

Conversation

@ianjmacintosh
Copy link
Contributor

Summary

Changed npm start -> npm run dev

npm start throws an error since it isn't a defined run script

I used the more verbose syntax to make it more obvious the user is calling a run script, not running an npm command named "dev"

Screenshots (optional)

n/a

Documentation checklist

Changed `npm start` -> `npm run dev`

`npm start` throws an error since it isn't a defined run script

I used the more verbose syntax to make it more obvious the user is calling a run script, not running an npm command named "dev"
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 17, 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 tutorial instructions to correct the command for starting the development server.

  • Changed npm start to npm run dev in the tutorial instructions
  • Clarified the command usage to indicate it's a run script
  • Ensured adherence to the documentation style guide

Modified Files

  • src/content/docs/pages/tutorials/build-an-api-with-pages-functions/index.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.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

Copy link
Collaborator

@kodster28 kodster28 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 finding / flagging, @ianjmacintosh.

Added the npm install bit as well based on my local testing.

@kodster28 kodster28 enabled auto-merge (squash) March 17, 2025 16:03
@kodster28 kodster28 merged commit f2de59f into cloudflare:production Mar 17, 2025
6 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Mar 17, 2025
@holopin-bot
Copy link

holopin-bot bot commented Mar 17, 2025

Congratulations @ianjmacintosh, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm8d9pvjh35670cl9id65jepu

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* Fix tutorial instruction

Changed `npm start` -> `npm run dev`

`npm start` throws an error since it isn't a defined run script

I used the more verbose syntax to make it more obvious the user is calling a run script, not running an npm command named "dev"

* Update src/content/docs/pages/tutorials/build-an-api-with-pages-functions/index.mdx

---------

Co-authored-by: Kody Jackson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:pages size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants