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

Update README.md #1325

Merged
merged 2 commits into from
Mar 18, 2022
Merged

Update README.md #1325

merged 2 commits into from
Mar 18, 2022

Conversation

emwdx
Copy link
Contributor

@emwdx emwdx commented Mar 15, 2022

Updated URLs for the getting started, reference, and FAQ pages.

Dear ml5 community,

I'm making a Pull Request(PR). Please see the details below.

A good PR 🌟

β†’ Step 1: Describe your Pull Request πŸ“

Fixing a Bug? Adding an Update? Submitting a New Feature? Does it introduce a breaking change?
I've clicked into the README file a few times this week and met the "Page Not Found, so here's Shiffman!" message a few times. I decided to do something about it!

β†’ Step 2: Share a Relevant Example πŸ¦„

Here's some example code or a demonstration of my feature as a part of this pull request, a separate pull request, in the https://editor.p5js.org, or codepen/jsfiddle/etc...

The links for reference, getting started, and FAQ all end up here:

Screen Shot 2022-03-15 at 3 13 02 PM

The best PR 🌟🌟🌟

β†’ Step 3: Screenshots or Relevant Documentation πŸ–Ό

Here's some helpful screenshots and/or documentation of the new feature

See above. I think I'm following the contribution guidelines, but this is my first EVER pull request on a project other than ones I've created, so I could be wrong.

Thanks for building this amazing resource!

Updated URLs for the getting started, reference, and FAQ pages.
Copy link

@proxycase proxycase left a comment

Choose a reason for hiding this comment

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

I've checked all the links and they seem to be accurate! I'd say this is a great and simple bugfix! Strange that the ml5js website has the /# at the end but not something you can really control here. Maybe for the first link you could get rid of it since it leads there anyway and if someone fixes it in the future, then it would still be correct.

removed # on first link
@tlsaeger tlsaeger added documentation SEMVER/patch a version tag for a patch release change labels Mar 18, 2022
@tlsaeger
Copy link
Member

@emwdx thanks for opening this and congrats on your first PR and first contribution. A very good catch. I removed the # on the first link as @proxycase suggested. I think the reason for this is how React, the framework very are using is handling routing. I will try to dig deeper into this.

Copy link
Member

@tlsaeger tlsaeger left a comment

Choose a reason for hiding this comment

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

Looks good!

@tlsaeger
Copy link
Member

@all-contributors please add @emwdx for doc

@allcontributors
Copy link
Contributor

@tlsaeger

I've put up a pull request to add @emwdx! πŸŽ‰

@tlsaeger tlsaeger merged commit f93d898 into ml5js:main Mar 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation SEMVER/patch a version tag for a patch release change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants