fable-arch icon indicating copy to clipboard operation
fable-arch copied to clipboard

Docs site updates

Open MangelMaxime opened this issue 8 years ago • 6 comments

  • [x] Add a sample to show async code
  • [x] Add a navigation sample
  • [ ] Add a plugin sample
  • [x] Find a way to add the React demo.
  • [ ] Add a new doc page explaining the glossary (App, Handler, etc.)
  • [x] Standalone samples using iframe
  • [x] Provide an easy way (template) in order to add a sample / demo

MangelMaxime avatar Jan 25 '17 05:01 MangelMaxime

The plugin sample should probably show how to set up producers and subscribers, too. I'm currently writing an app using fable-elmish because I could understand its structure, but fable-arch's producer/subscriber infrastructure (and the distinction between AppMessages and regular messages) is still a bit hard for me to get a handle on, even though I've been reading the code. I learn best through examples, so I'm looking forward to those.

rmunn avatar Jan 31 '17 06:01 rmunn

Thanks for your feedback. :)

The explanations should be provided by the different samples/docs to help understand the different case.

MangelMaxime avatar Jan 31 '17 09:01 MangelMaxime

@MangelMaxime hey, isn't it good is sample shown on docs site are in sync with samples shown here? For simple example I couldn't find "classy" in sample while it is there on doc site. Or may be you can share link of doc examples. Complete one?

kunjee17 avatar Feb 01 '17 12:02 kunjee17

The sample shown on the docs site are inside this folder:

We are working to have a better management of the sample and make them independant from the docs site again.

All the samples inside the root/samples directory are not used in the docs site for the moment this is why you don't see classy in the code.

Otherwise, classy is an helper provided by Fable-arch you just need to open Fable.Arch.Html

MangelMaxime avatar Feb 01 '17 13:02 MangelMaxime

Suggestions

  • A "Getting Started" Page in the Docs tab to show how to set up a simple project
  • A react sample to show how to use external components (like material-ui for example) in fable.arch

Zaid-Ajaj avatar Feb 04 '17 19:02 Zaid-Ajaj

Docs site updated. Feedbacks are welcomed.

MangelMaxime avatar Mar 01 '17 22:03 MangelMaxime