kylefang/IGListKit
1
0
Fork 0
mirror of https://github.com/tappollo/IGListKit.git synced 2026-04-30 12:51:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Regenerate docs, move docs build script

Browse Source 
Summary:
- Move docs script to `scripts/`
- Add small note on README about regenerating docs
- Re-gen docs (doing this because of all the recent spelling, etc. fixes -- note, no breaking changes have landed, so we're good to re-gen.)
Closes https://github.com/Instagram/IGListKit/pull/797

Differential Revision: D5162705

Pulled By: rnystrom

fbshipit-source-id: 83cb0f171c10526a8a4b5d8a746fc2226987f256
This commit is contained in:
Jesse Squires
2017-05-31 20:51:02 -07:00
committed by Facebook Github Bot
parent 81955e4106
commit 895de471ba
51 changed files with 120 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -85,6 +85,8 @@ github "Instagram/IGListKit" ~> 3.0
You can find [the docs here](https://instagram.github.io/IGListKit). Documentation is generated with [jazzy](https://github.com/realm/jazzy) and hosted on [GitHub-Pages](https://pages.github.com).
To regenerate docs, run `./scripts/build_docs.sh` from the root directory in the repo.
## Vision
For the long-term goals and "vision" of `IGListKit`, please read our [Vision](https://github.com/Instagram/IGListKit/blob/master/Guides/VISION.md) doc.
@@ -93,7 +95,7 @@ For the long-term goals and "vision" of `IGListKit`, please read our [Vision](ht
Please see the [CONTRIBUTING](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) file for how to help. At Instagram, we sync the open source version of `IGListKit` daily, so we're always testing the latest changes. But that requires all changes be thoroughly tested and follow our style guide.
We have a set of [starter tasks](https://github.com/Instagram/IGListKit/issues?q=is%3Aissue+is%3Aopen+label%3Astarter-task) that are great for beginners to jump in on and start contributing.
We have a set of [starter tasks](https://github.com/Instagram/IGListKit/issues?q=is%3Aissue+is%3Aopen+label%3Astarter-task) that are great for beginners to jump in on and start contributing.
## License