donejs / donejs/bit-docs-donejs-theme

Refactor Client-Side JavaScript

Open
#48 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Much of the client JS has become unruly, [static.js](https://github.com/donejs/bit-docs-donejs-theme/blob/master/static/static.js) for example, is a pile of spaghetti heavily spiced with jQuery.

__I propose the following changes__:
- Refactor all of `/static/static.js`.
- Modularize/Organize into components.
- Use CanJS instead of jQuery where possible.
- Consider using Bootstrap's scroll spy plugin.
- Remove plugins from `/static/js`
- Replace with NPM modules
- Consider rewriting them with CanJS
- Remove most or all of the JS for responsive stuff. Everything I have seen so far could be done with pure CSS.
- Write tests for as much of the client code as is reasonable.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.