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

Fix (updated README and fixed dependency vulnerabilities) #3

Merged
merged 1 commit into from
Jun 7, 2023

Conversation

mapachurro
Copy link

Updated README to include more context, updated the 'Create new docs' flow so it doesn't refer to forking, ran npm audit fix to start to address vulnerabilities.

Pull request checklist

Make sure that:

Describe the change

  • This template / repo is starting to have lots of dependency security issues. I ran 'npm audit fix', which fixed 3 of them automatically, but there are a lot more 😥
  • The README on the repo was minimal to the point of being confusing. Non-technical people in ConsenSys are being pointed to the repo as a resource, and when they get there, they don't know what's going on. I adapted a lot of content from the 'Create new docs' flow to explain it a bit more.
  • Additionally, the 'create new docs' flow referred to forking the repo, which is actually a completely different flow than what we want users to be doing. So I changed that, as well.

Issue fixed

N/A

Impacted parts

The README, the Create new docs flow, and the package.json.

For content changes:

  • Documentation content
  • Documentation page organization

For tool changes:

  • Docusaurus build changes
  • Package dependencies
  • GitHub CI

After creating your PR and tests have finished

Make sure that:

  • You've fixed any issues raised by the tests.
  • You've previewed the build which is auto-deployed by Vercel below.

…ADME, package.json

Updated README to include more context, updated the Create new docs flow so it doesn't refer to
forking, ran npm audit fix to start to address vulnerabilities.
@vercel
Copy link

vercel bot commented Jun 1, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 1, 2023 1:22pm

@github-actions
Copy link

github-actions bot commented Jun 7, 2023

🎉 This PR is included in version 1.18.4 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants