cfpb / capital-framework

The Consumer Financial Protection Bureau's user interface framework
https://cfpb.github.io/capital-framework/
Creative Commons Zero v1.0 Universal
55 stars 29 forks source link

Update docs for Capital Framework v7.3.0 + other hygiene #870

Closed Scotchester closed 5 years ago

Scotchester commented 5 years ago

Also includes some GitHub Pages hygiene updates.

Additions

Removals

Changes

Testing

  1. Pull branch
  2. npm run cf-unlink, in case you have any local dev links still in place
  3. npm install
  4. gulp
  5. bundle update
  6. bundle exec jekyll serve watch
  7. Load up http://localhost:4000/ and surf around; make sure nothing looks broken

Notes

Checklist

Scotchester commented 5 years ago

Those Snyk errors are expected; this branch doesn't have those files in it.

anselmbradford commented 5 years ago

Some things you might want to fix while you're in here:

Scotchester commented 5 years ago

@anselmbradford Thanks for the helpful review!

  1. Broken compiled source links: As noted in https://github.com/cfpb/capital-framework/pull/846#issuecomment-439160938, looks like this has been broken since 7.0.0. We need to put the .npmignore back with an explanation that it's required for npm to not ignore that dist folder, which needs to be done in a canary/master PR and a new release.
  2. Usage TOC link error: This also needs to be updated in the component's source usage.md file.

Other changes have been made!