Skip to content

Documentation overhaul #124

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.

Sign up for GitHub

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

Jump to bottom
Closed
12 tasks done
jmdobry opened this issue Aug 20, 2014 · 0 comments
Closed
12 tasks done

Documentation overhaul #124

jmdobry opened this issue Aug 20, 2014 · 0 comments
Assignees
@jmdobry
Labels
docs done
Milestone
1.0.0-beta.1

Comments

@jmdobry
Copy link
Member

jmdobry commented Aug 20, 2014

  • - Comb through the API and make sure it is fully and correctly documented with examples
    • - Async methods
    • - Sync methods
    • - http adapter
    • - localStorage adapter
  • - Flesh out the guides to be more thorough
  • - Make a clearer distinction between the data store (DS), adapters, and angular-cache
  • - Refresh the style/design of the documentation site
  • - Remove the chart
  • - Add important links to documentation home page
  • - Fix responsive styles
  • - Add prerender or something for SEO
@jmdobry jmdobry added this to the 1.0.0-beta.1 milestone Aug 20, 2014
@jmdobry jmdobry self-assigned this Aug 20, 2014
jmdobry added a commit that referenced this issue Aug 21, 2014
@jmdobry
Cleaned and corrected api documentation for the async DS methods. #124.
b0f7421
jmdobry added a commit that referenced this issue Aug 21, 2014
@jmdobry
Restyled documentation site. #124.
fb7578c
jmdobry added a commit that referenced this issue Aug 22, 2014
@jmdobry
Cleaned and corrected api documentation for sync DS methods. #124.
fb65a0e
jmdobry added a commit that referenced this issue Aug 23, 2014
@jmdobry
Fixed DSLocalStorageAdapter api documentation. #124.
e8f77e7
jmdobry added a commit that referenced this issue Aug 23, 2014
@jmdobry
Added some missing documentation. #124.
d8dec59
jmdobry added a commit that referenced this issue Aug 23, 2014
@jmdobry
Documentation home page updates. #124.
6e0e000
jmdobry added a commit that referenced this issue Aug 23, 2014
@jmdobry
Fixed responsive styles. #124.
14584ff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jmdobry jmdobry

Labels
docs done
Projects
None yet
Milestone
1.0.0-beta.1
Development

No branches or pull requests
1 participant
@jmdobry