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

Standardize example documentation across repos #26

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

Conversation

libutcher
Copy link
Contributor

@libutcher libutcher commented Apr 10, 2024

This PR standardizes the example folders across our repos. It includes the following changes:

  • Edits to the README, including adding a description of the example to the intro, changing the header to "prerequisites," and adding an instruction to follow the steps to get started before running the example.
  • Edits to the example code comments to include a bit more information and use the same wording as I've proposed in the other repos.

Closes #25

Question:

  1. Is it necessary to go through the "get started" steps before running this? For example, would this work correctly without making any changes to the .npmrc file or setting the NPM token?

@libutcher libutcher self-assigned this Apr 10, 2024
@libutcher libutcher requested a review from AndyTitu April 10, 2024 15:06
@libutcher
Copy link
Contributor Author

@AndyTitu The PRs to standardize the example readmes and code comments are ready! Please make sure to take a look at the questions in each PR description - there are a few details I was unsure of that your opinion would be helpful on. Thank you!

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.

Standardize example code comments
1 participant