Skip to content
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.

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

Documentation disappeared #334

Closed
ArthurClemens opened this issue Sep 14, 2013 · 9 comments
Closed

Documentation disappeared #334

ArthurClemens opened this issue Sep 14, 2013 · 9 comments

Comments

@ArthurClemens
Copy link

fay-lang.org redirects now to this repo. I understand the original site contained documentation and demos - these are inaccessible.

@chrisdone
Copy link
Contributor

We moved to the wiki a while ago. Probably updating the wiki is better. Although I can pass the domain over to @bergmark if he wants to repoint it to use Github's home pages or w/e.

@bergmark
Copy link
Member

I don't think there's that much missing from the old website. There were some code generation examples that are probably outdated by now but we could add anything like that to the wiki!

@bnolan
Copy link

bnolan commented Sep 27, 2013

We really could do with some example code / a tutorial.

@bergmark
Copy link
Member

What would you like the tutorial to address?

@bnolan
Copy link

bnolan commented Oct 3, 2013

An introduction to haskell using faye, showing what it supported, using the FFI to call out to javascript, and using javascript to call fay functions?

@bergmark
Copy link
Member

bergmark commented Oct 3, 2013

We have some of this on the wiki already:

I added a page for what is not supported:

It's pretty hard to make an exhaustive list of what we do or don't support, and I'm not sure how useful it would be, but I'll keep adding things here if I come across things I think people care to know about :)

@chreekat
Copy link

As a small suggestion, I would suggest putting critical docs like "Installing and Running" somewhere other than under the heading, "Misc" :)

As for a bare-bones introduction to the ffi, here's a hello-world I just made. I don't know if it is useful to read, but it was very useful to write.

You could also point to the existing alert.hs as a super tiny code example.

@bergmark
Copy link
Member

Heh, I was reorganizing that but I think i got distracted half way through or something :) Updated it, and added the alert example.

@bergmark
Copy link
Member

I opened #358 for further documentation suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants