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

Make sure documentation is up to date #62

Open

5 of 6 tasks

GGAlanSmithee opened this issue May 24, 2018 · 1 comment

Labels

documentation enhancement help wanted

Milestone

Owner

GGAlanSmithee commented May 24, 2018 •

edited

Loading

I've noticed that some documentation is out of date and incorrect, should go through all and make sure it matches the latest version, 3.0.0.

migrate from v2 -> v3
changelog
examples
general overhaul for readability
~~separate docs start page from README.md~~
add comments to typescript definitions to make them a part of the autogenerated API docs

GGAlanSmithee added enhancement help wanted labels

GGAlanSmithee added this to the v 3.0.0 milestone

GGAlanSmithee modified the milestones: v 3.0.0, 3.1.0

GGAlanSmithee added the documentation label

Owner Author

GGAlanSmithee commented Nov 23, 2018

This is moving along quite well in the new gh-pages branch. "Only" the migration docs left.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment