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

Codebase Cleanup #6

Closed
wojtek-krysiak opened this issue Mar 20, 2019 · 1 comment
Closed

Codebase Cleanup #6

wojtek-krysiak opened this issue Mar 20, 2019 · 1 comment

Comments

@wojtek-krysiak
Copy link
Contributor

Codebase Cleanup

  • moving from jQuery to using native browser API's
  • using const, and let vs var.
  • removing the global state from publish.js and making it more functional and atomic, i.e., functions mutate, and return mutated inputs rather than altering the global state.
  • remove readme folder, and remove images from the README
    • while these are nice, they take all the space above-the-fold, whereas it's always nice to have a project description in that space IMO. Demos could be provided on a jsdoc generated documentation page for the project using the project. See Dogfooding/Example below.
  • rename static to public
    • remove all code in static
  • move tmpl to public
  • create public/assets and put the font-awesome heart icon into the folder
  • move styles to src/styles
  • move scripts to src/js, and update to use import syntax for use with Rollup
  • remove third-party (vendor) JavaScript, e.g., prettify, and use npm.
  • Use CDN for all third-party JS, and CSS.
  • introduce preload, and prefetch in the head
  • remove font-awesome and inline the heart icon as an SVG
@JustinBeaudry
Copy link

I have this issue already completed, I just need to make a PR. Can you assign it to me?

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

No branches or pull requests

2 participants