Commit Graph

292 Commits

Author SHA1 Message Date
Mike Thompson 5cc48d54eb WIP on new docs 2016-10-21 16:09:39 +11:00
Mike Thompson be9e4521c2 And again 2016-10-21 07:25:54 +11:00
Mike Thompson 9f988395d0 Next image experiment - getting closer 2016-10-21 07:21:21 +11:00
Mike Thompson 87383a9042 Next experiment (I have to see what Github does with it) 2016-10-21 07:18:46 +11:00
Mike Thompson 6712cad85d Another experiement 2016-10-21 07:17:18 +11:00
Mike Thompson 6d2c6c1074 Experimenting with right-floating images and Git flavored markdown. 2016-10-21 07:12:49 +11:00
Mike Thompson 0638becd45 WIP on the new README and initial docs 2016-10-21 07:07:56 +11:00
Shaun Mahood fa39d73223 Update README.md 2016-10-19 13:53:46 -06:00
Mike Thompson dd4bf987aa Add Testing WIP 2016-10-19 21:25:08 +11:00
Mike Thompson 76a52d5cd0 Extra docs on Debugging 2016-10-19 21:25:07 +11:00
Mike Thompson 202318b874 WIP on the new README 2016-10-19 21:25:05 +11:00
Mike Thompson 772d9b0348 Event Handler docs 2016-10-19 21:25:04 +11:00
Mike Thompson e861c8204d Change a word or two in Interceptors.md 2016-10-19 21:25:03 +11:00
Mike Thompson b69e0a44e0 Clarify meaning of equals in doc 2016-10-19 21:25:02 +11:00
Shaun Mahood c66366425c Merge pull request #256 from kana-sama/patch-1
Fix links for builtin effect handlers
2016-10-18 13:55:29 -06:00
kana-sama 5da2e803a2 Fix links fot builtin effect handlers 2016-10-18 19:34:17 +03:00
Shaun Mahood 846a30e3f5 Merge pull request #251 from kapware/patch-1
Added :response-format, without that it fails.
2016-10-13 10:43:10 -06:00
Shaun Mahood 35f2722be4 Update Talking-To-Servers.md 2016-10-13 10:41:02 -06:00
kapware 0b23e2ade6 Added :response-format, without that it fails.
Without this line the event fails as the response is not properly formatted.
2016-10-13 18:29:00 +02:00
Daniel Compton c14935dea6
Spelling fixes 2016-10-13 17:44:29 +13:00
Evan Rubinton df8c1f41c8 Fix typos in Interceptors.md (#240) 2016-10-13 17:35:37 +13:00
Shaun Mahood 961f6535b9 Add project readme to docs table of contents (#247) 2016-10-13 17:33:57 +13:00
Shaun Mahood e40ef73c4a Update Coeffects.md
Added 1 whole space
2016-10-05 22:34:06 -06:00
Shaun Mahood a29317597a Fix to docs/interceptors.md
Remove incorrect duplicate navigation footer
2016-10-04 22:49:33 -06:00
Shaun Mahood 037a127fb7 Update Effects.md 2016-10-03 21:05:28 -06:00
Matus Lestan a6191440ef Added Google Analytics Effect Handlers 2016-10-04 00:59:01 +02:00
Shaun Mahood 3ef6304857 Merge pull request #235 from micmarsh/patch-1
Fix typo in first effect map
2016-10-03 15:29:55 -06:00
Shaun Mahood a28440578b Merge pull request #238 from si14/patch-3
Inline refheap snippets
2016-10-03 15:27:51 -06:00
Shaun Mahood 78bb9b468a Adding external effects from @madvas
Manually adding changes from PR #244 rather than fixing merge conflicts.
2016-10-03 15:23:10 -06:00
Shaun Mahood fcd7bd5832 Merge pull request #243 from madvas/patch-1
Added tutorial link
2016-10-03 15:17:03 -06:00
Shaun Mahood ce9b951ea8 Update External-Resources.md 2016-10-03 15:15:14 -06:00
Shaun Mahood 3c319c0594 Update External-Resources.md 2016-10-03 15:14:37 -06:00
Matus Lestan 533d845ae1 Added tutorial link 2016-10-03 22:27:24 +02:00
Michael Marsh 655c6b8e22 Adding my YouTube library to External Effects 2016-10-03 15:52:51 -04:00
Dmitry Groshev a9be8cfd1a Inline refheap snippets
Refheap links are unreliable, so it's better to inline the linked code (see #232)
2016-09-27 19:08:44 +03:00
Michael Marsh 7756faa5c8 fix two types in first effect map 2016-09-12 09:49:58 -04:00
Henrik Mohr e2bd2ca83b Minimal typos 2016-09-07 15:16:57 +02:00
Mike Thompson 1475a2ef1b docs gardening 2016-09-07 15:40:52 +10:00
Mike Thompson 9b72c543b1 Add `Debugging-Event-Handlers.md` docs 2016-09-05 22:08:25 +10:00
Mike Thompson 92e0ad034e Improve the FAQ entry on inspecting state 2016-09-05 20:37:00 +10:00
Mike Thompson 80c3a56771 WIP on Debugging Event Handlers 2016-09-05 15:04:30 +10:00
Shaun Mahood 5068a04007 Update External Resources
Manually adding changes from PR #227 to develop branch
2016-09-04 22:22:33 -06:00
Toni Reina fe6a460114 Fix typo in docs/Subscribing-To-External-Data 2016-09-04 19:43:44 -05:00
Toni Reina 2ee840b3e8 Close paren correctly in Coeffects snippet 2016-09-04 19:42:58 -05:00
Mike Thompson f4dc265ef5 Remove line wrap 2016-09-04 04:50:36 +10:00
Mike Thompson a1e9461f63 Add Debugging doc 2016-09-04 04:47:03 +10:00
Mike Thompson e40c21147b Remove duplicate text in docs 2016-09-03 18:46:00 +10:00
Mike Thompson 2fa1aea94c Merge pull request #225 from areina/fix-typo-in-docs
Fix typo in docs/Talking-To-Servers.md
2016-09-03 15:25:31 +10:00
Toni Reina 9a4be58fa0 Fix typo in docs/Talking-To-Servers.md 2016-09-02 23:30:55 -05:00
Shaun Mahood 1815fc1b13 Update docs README and rename External-Docs 2016-09-02 13:24:09 -06:00
Shaun Mahood b83bf6c37a Add updated version of External Resources to Docs 2016-09-02 13:17:46 -06:00
Shaun Mahood 04d0a9e9af Minor docs fixes 2016-09-01 12:53:02 -06:00
Mike Thompson 08b4b8569e Word fiddling 2016-09-01 13:12:19 +10:00
Mike Thompson 9a9ec3827b Better code in Interceptors docs. Plus fix up titles. 2016-08-31 23:27:07 +10:00
Mike Thompson 5c0268411b Merge branch 'master' of https://github.com/Day8/re-frame 2016-08-31 22:55:10 +10:00
Mike Thompson 211a033d6d Merge branch 'develop' of https://github.com/Day8/re-frame into develop 2016-08-31 22:53:59 +10:00
Mike Thompson f09755c91a wording teaks in docs 2016-08-31 22:53:40 +10:00
Mike Thompson c3258ca303 Merge pull request #220 from si14/master
consistent Coeffects capitalization in docs
2016-08-31 22:52:04 +10:00
Dmitry Groshev b0371ae3d3 Fix typo in a link to Effectful Handlers doc 2016-08-30 20:22:14 +03:00
Dmitry Groshev 1e2c6703f5 Add missing handler to "Loading Initial Data" doc
"The pattern" implies `:initialise-db` handler, but it is missing. This PR adds a very simple implementation.
2016-08-30 20:18:42 +03:00
Dmitry Groshev 10ff719eb8 add missing language name to a code snippet in Coeffects doc 2016-08-30 20:07:11 +03:00
Dmitry Groshev 486186371b consistent Coeffects capitalization in docs 2016-08-30 19:51:47 +03:00
Mike Thompson 005f76c0a6 more docs tweaking 2016-08-31 00:31:36 +10:00
Mike Thompson e04e9fc9ad Tweak "Performance Problems" 2016-08-31 00:28:35 +10:00
Mike Thompson 8a07f49c64 A bit of docs gardening on `CPU-hog` 2016-08-31 00:20:50 +10:00
Mike Thompson 48de6d4a81 Add `Performance-Problems.md` document 2016-08-31 00:20:23 +10:00
Mike Thompson a24d5414b3 Still experimenting - searching for a nicely rendered `/docs` README 2016-08-30 20:04:09 +10:00
Mike Thompson f3c849ee83 Change README to use smaller section titles 2016-08-30 17:50:53 +10:00
Mike Thompson f8b7d082fd Add new doc - Solving The CPU Hog Problem 2016-08-30 17:40:21 +10:00
Shaun Mahood d6187b3259 Fix typo in docs 2016-08-29 13:19:35 -06:00
Mike Thompson 7a2dcb3f58 Get the line lengths right, to make reading flow. 2016-08-30 00:59:53 +10:00
Mike Thompson 11821950b5 Experiment with line width for easy reading. 2016-08-30 00:00:15 +10:00
Mike Thompson 6db396381f More misc docs 2016-08-29 23:49:00 +10:00
Mike Thompson 781e7ca323 Experiment with FAQ formatting 2016-08-29 23:06:41 +10:00
Mike Thompson 8260e41c60 link correction 2016-08-29 22:58:45 +10:00
Mike Thompson a4d341ec4b WIP on FAQ 2016-08-29 22:57:35 +10:00
Mike Thompson 651cbd7059 docs 2016-08-29 14:05:29 +10:00
Mike Thompson a0679e12a2 More docs 2016-08-29 13:11:29 +10:00
Shaun Mahood 436bd5917b Fix docs navigation in navigation doc
Quite the commit message, isn’t it?
2016-08-28 09:55:29 -06:00
Shaun Mahood 2ebff40373 Docs Navigation
Fix links to Index and wrong navigation links
2016-08-28 09:50:15 -06:00
Shaun Mahood ed19f36376 Fix typo 2016-08-28 09:41:52 -06:00
Shaun Mahood d4f51f933b Docs navigation
Add navigation to bottom of docs that don’t have it, update existing to
match current doc structure
2016-08-28 09:40:00 -06:00
Mike Thompson 89706f8655 Add some more explanation to Interceptor wrappers. 2016-08-28 10:08:09 +10:00
Mike Thompson 209f36a0c2 Better highlighting in docs 2016-08-28 10:07:46 +10:00
Mike Thompson 2d15246b4d typo correction 2016-08-28 10:07:24 +10:00
Dmitri Sotnikov b7cd31575b fixed typo in reg-event-fx 2016-08-27 12:48:44 -04:00
Mike Thompson 657a6935be Miscellaneous doc tweaks 2016-08-27 12:41:41 +10:00
Mike Thompson b4b8b75ae2 A quick pass over Talking-To-Servers 2016-08-26 12:58:17 +10:00
Mike Thompson 097f05029c First pass over Subscribing-To-External_Data 2016-08-26 12:51:26 +10:00
Shaun Mahood 2c0177a8a4 Typo fix 2016-08-25 14:44:34 -06:00
Shaun Mahood 6bd664404f Merge remote-tracking branch 'refs/remotes/Day8/master' 2016-08-25 14:40:48 -06:00
Shaun Mahood ebf0d874d0 First attempt at updating Subscribing To A Database documentation 2016-08-25 14:40:40 -06:00
Mike Thompson b6bf672734 Dashes on docs 2016-08-25 23:35:48 +10:00
Mike Thompson 55a0dfe2d0 Docs Tinkering 2016-08-25 21:52:39 +10:00
Mike Thompson 5628ea3f14 Another pass over Loading-Initial-Date doc 2016-08-25 21:52:22 +10:00
Mike Thompson 6d11a0116d One pass over loading-initial-data docs 2016-08-25 19:24:00 +10:00
Mike Thompson 06ddd2e852 Merge branch 'develop' of https://github.com/Day8/re-frame into develop 2016-08-25 18:40:21 +10:00
Mike Thompson 86e6189525 A couple of tiny docs tweaks 2016-08-25 18:40:07 +10:00
Shaun Mahood bbbab3d5b6 Update and rename "Bootstrap-An-Application" docs
Bootstrap An Application (originally from wiki)
- renamed to "Loading Initial Data"
- Updated to work with 0.8.0 and some tweaks to wording
- Added a bit more context to dispatch-sync section
- Removed section on loading data and put link to "Talking to Servers"
doc instead
docs/README.md
- Reorganized under a new section
- Added a couple entries for future documentation
2016-08-24 22:27:48 -06:00
Mike Thompson 9722fdbade Better ascii hierarchy 2016-08-25 00:53:37 +10:00
Tomas Drencak cbfd1ccdeb typo fix 2016-08-25 00:42:31 +10:00
Mike Thompson 2049731bbd More docs massaging. 2016-08-25 00:41:56 +10:00
Mike Thompson b391c03a3e Add first cut of talking to servers docs 2016-08-25 00:30:38 +10:00
Mike Thompson 3d3c7a1ccd Add navigation to docs pages 2016-08-25 00:30:37 +10:00
hipitihop 733ad218a2 Update fx-test fixtures to use re-frame.core/make-restore-fn & update docs 2016-08-24 10:44:21 +10:00
Shaun Mahood 344cd6036a Minor formatting change 2016-08-23 15:32:18 -06:00
Shaun Mahood d0614a52a2 Change format a bit 2016-08-23 15:31:11 -06:00
Shaun Mahood 8efe6dff04 Rename A-Larger-App.md 2016-08-23 15:20:54 -06:00
Shaun Mahood f168a7f821 Fix minor error in README 2016-08-23 15:18:42 -06:00
Shaun Mahood e1d69fc7b5 Break apart A-Larger-App docs and restructure README 2016-08-23 15:17:59 -06:00
Shaun Mahood f63ae9364c Update for 0.8.0 and minor edits 2016-08-23 15:07:14 -06:00
Paulus Esterhazy cc2354b988 Correct typo
I think this corrects the text to the intended meaning.
2016-08-22 22:56:47 +02:00
Andrew Dolby 3ab43d52b4 Cleanup docs 2016-08-19 14:47:37 -04:00
Mike Thompson 48faedb082 More docs work 2016-08-19 15:32:51 +10:00
Mike Thompson ad66b89abc Fix up wording. 2016-08-18 11:58:39 +10:00
Mike Thompson c1b9859941 Coeffect docs improved 2016-08-18 11:58:32 +10:00
hipitihop 2f6fbc1c6b comment typo 2016-08-18 11:39:30 +10:00
Mike Thompson 4c5d28fc18 Docs gardening 2016-08-17 08:44:07 +10:00
Mike Thompson fead1b04b3 More docs review 2016-08-17 00:08:30 +10:00
Mike Thompson 3f0679f396 More work on Coeffects docs - probably only 10 more passes to go :-) 2016-08-16 19:00:56 +10:00
Mike Thompson 0c8d4c14e3 Another gardening pass over Interceptors docs 2016-08-16 19:00:10 +10:00
Mike Thompson baa61a3749 Complete rename from `do-effects` to `do-fx` 2016-08-16 13:00:52 +10:00
Mike Thompson 4f2f772afd The function `coeffect` is renamed to `inject-cofx`.
When writing the docs I found that sentences had too many mentions of `coeffects` with different meanings, which was confusing.  With this change, I remove one possible meaning of `coeffect` and, in the process I end up with a clearer name anyway.
2016-08-16 12:30:01 +10:00
Mike Thompson 0ec80051c6 Add a TOC 2016-08-15 23:13:53 +10:00
Mike Thompson 3f36450be8 Readme in docs now correctly links to other pages. 2016-08-15 23:05:10 +10:00
Mike Thompson 821208fabf WIP Coeffects doc 2016-08-15 22:54:23 +10:00
Mike Thompson 7ca8d4fecc Shuffle Effects docs 2016-08-15 18:11:28 +10:00
Mike Thompson e336403a75 Coeffects docs are almost finished 2016-08-15 18:11:06 +10:00
Mike Thompson af5a1898c8 Add description of effects with no data 2016-08-15 12:28:18 +10:00
Mike Thompson dc9ff36057 WIP on coeffects docs (50% done, but very, very rough) 2016-08-15 11:56:39 +10:00
Mike Thompson 2793955276 Minor gardening on docs 2016-08-15 11:56:03 +10:00
Mike Thompson 108ee61220 Gardening passes over docs 2016-08-14 14:42:32 +10:00
Mike Thompson 3bcba7b796 Table Of Contents for Interceptors 2016-08-13 16:34:25 +10:00
Mike Thompson 7597a6e34d More effects love, including a TOC 2016-08-13 16:11:11 +10:00
Mike Thompson 401d1baa76 More on Effects doc - including adding TOC. Want to see it work on Github. 2016-08-13 13:18:17 +10:00
Mike Thompson 069aa0475c Add quote to docs 2016-08-12 23:49:15 +10:00
Mike Thompson d08f1c910d Add a quote to Effectful Handlers 2016-08-12 23:47:56 +10:00
Mike Thompson 7b70b79590 Add the next document on Effects 2016-08-12 23:47:20 +10:00
Mike Thompson de25e28997 More docs WIP 2016-08-11 23:24:39 +10:00
Mike Thompson e3812b455d Rework interceptor docs 2016-08-11 16:09:43 +10:00
Mike Thompson 8bffbcdc18 First cut on interceptors doc 2016-08-11 14:33:28 +10:00
Mike Thompson a14ae8a925 Beginning The Re-Doc-ing of re-frame 2016-08-11 09:01:39 +10:00