status-im
/
re-frame
mirror of https://github.com/status-im/re-frame.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Minor tweaks to way docs are presented to reader.

This commit is contained in:
Mike Thompson 2017-10-13 10:51:19 +11:00
parent 00ee8e8084
commit cd1c947e20
3 changed files with 11 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Contributing to re-frame
Thank you for taking the time to contribute! Please note that re-frame follows a [code of conduct](docs/Code-Of-Conduct.md).
Thank you for taking the time to contribute!
## Support questions

43
docs/Code-Of-Conduct.md
View File

@ -1,43 +0,0 @@
# Open Source Code of Conduct
In order to foster an inclusive, kind, harassment-free, and cooperative community, Day8 enforces this code of conduct on our open source projects.
## Summary
Harassment in code and discussion or violation of physical boundaries is completely unacceptable anywhere in Day8’s project codebases, issue trackers, chatrooms, mailing lists, meetups, and other events. Violators will be warned by the core team. Repeat violations will result in being blocked or banned by the core team at or before the 3rd violation.
## In detail
Harassment includes offensive verbal comments related to gender identity, gender expression, sexual orientation, disability, physical appearance, body size, race, religion, sexual images, deliberate intimidation, stalking, sustained disruption, and unwelcome sexual attention.
Individuals asked to stop any harassing behavior are expected to comply immediately.
Maintainers are also subject to the anti-harassment policy.
If anyone engages in harassing behavior, including maintainers, we may take appropriate action, up to and including warning the offender, deletion of comments, removal from the project’s codebase and communication systems, and escalation to GitHub support.
If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact a member of the core team or email conduct@day8.com.au immediately.
We expect everyone to follow these rules anywhere in Day8's project codebases, issue trackers, chatrooms, and mailing lists.
Finally, don't forget that it is human to make mistakes! We all do. Let’s work together to help each other, resolve issues, and learn from the mistakes that we will all inevitably make from time to time.
## Thanks
Thanks to the [Thoughtbot Code of Conduct][thoughtbot], [CocoaPods Code of Conduct][cocoapods], [Bundler Code of Conduct][bundler], [JSConf Code of Conduct][jsconf], and [Contributor Covenant][contributor] for inspiration and ideas.
## License
To the extent possible under law, the Day8 team has waived all copyright and related or neighboring rights to Day8 Code of Conduct. This work is published from Australia.
<a href="http://creativecommons.org/publicdomain/zero/1.0/" rel="CC0"><img src="https://licensebuttons.net/p/zero/1.0/88x31.png" alt="CC0 licensed" /></a>
[thoughtbot]: https://thoughtbot.com/open-source-code-of-conduct
[cocoapods]: https://github.com/CocoaPods/CocoaPods/blob/master/CODE_OF_CONDUCT.md
[bundler]: http://bundler.io/conduct.html
[jsconf]: http://jsconf.com/codeofconduct.html
[contributor]: http://contributor-covenant.org/
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

19
docs/README.md
View File

@ -1,14 +1,10 @@
# Table of content
## Introduction
* First, read this repo's README
* First, read this repo's [README](../README.md)
* [app-db (Application State)](ApplicationState.md)
* [First Code Walk-Through](CodeWalkthrough.md)
* [The API](API.md)
* [Mental Model Omnibus](MentalModelOmnibus.md)
* Alternative Introductions:
* [purelyfunctional.tv](https://purelyfunctional.tv/guide/re-frame-building-blocks/) - a detailed, well written introduction. (Plus they have commercial videos)
* [Lambda Island Videos](https://lambdaisland.com/episodes) - commercial videos on many clojure topics, including re-frame and reagent. Some are free.
## Dominoes 2 & 3
* [Infographic Overview](EventHandlingInfographic.md)
@ -23,7 +19,6 @@
* [Correcting a wrong](SubscriptionsCleanup.md)
* [Flow Mechanics](SubscriptionFlow.md)
## Domino 5
* Reagent Tutorials
* [The Basics](https://github.com/Day8/re-frame/wiki#reagent-tutorials) (look at the bottom of that page)
@ -32,6 +27,15 @@
* [Reagent Deep Dive Series from Timothy Pratley](http://timothypratley.blogspot.com.au/p/p.html) four part series
* [Props, Children & Component Lifecycle](https://www.martinklepsch.org/posts/props-children-and-component-lifecycle-in-reagent.html) by Martin Klepsch
## Deepen Your Knowledge
* [Mental Model Omnibus](MentalModelOmnibus.md)
* [FAQs](FAQs/README.md)
* [External Resources](External-Resources.md)
* Alternative Introductions:
* [purelyfunctional.tv](https://purelyfunctional.tv/guide/re-frame-building-blocks/) - a detailed, well written introduction. (Plus they have commercial videos)
* [Lambda Island Videos](https://lambdaisland.com/episodes) - commercial videos on many clojure topics, including re-frame and reagent. Some are free.
## App Structure
* [Basic App Structure](Basic-App-Structure.md)
* [Navigation](Navigation.md)
@ -48,10 +52,7 @@
* [Testing](Testing.md)
## Miscellaneous
* [FAQs](FAQs/README.md)
* [External Resources](External-Resources.md)
* [Eek! Performance Problems](Performance-Problems.md)
* [Solve the CPU hog problem](Solve-the-CPU-hog-problem.md)
* [Using Stateful JS Components](Using-Stateful-JS-Components.md)
* [The re-frame Logo](The-re-frame-logo.md)
* [Code Of Conduct](Code-Of-Conduct.md)