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

Suggest documentation improvements here! #358

Open
bergmark opened this issue Oct 25, 2013 · 5 comments
Open

Suggest documentation improvements here! #358

bergmark opened this issue Oct 25, 2013 · 5 comments

Comments

@bergmark
Copy link
Member

I'd like to make the fay wiki public, but github wikis don't support diffs so it's very hard to see the changes people make.

This ticket can serve as a place for everyone to post things they would like to add or see explained better.

@j-hannes
Copy link

I really liked the way it was done on the fay-lang.org website, one document following a simple pattern from an introduction over installation notes to the demonstration of some simple examples. Always wondered why this has been removed.

I know the content is still in the wiki here and the examples (plus many more) can found in the repo, but I find the information not so accessible any more, especially when you haven't heard of fay and just want to get an idea what this is about and how it works.

Maybe we can build a page similar to the first one (github.io or something), which scrolls down showing some examples. Users might be most interested how fay can be installed and then how it can be used instead of writing JS code in their web or node apps.

@chrisdonegoogle
Copy link

It was more arcane to contribute to in the old way. We could use Github
pages with the github.io stuff.

On 26 October 2013 22:07, J-Hannes notifications@github.com wrote:

I really liked the way it was done on the fay-lang.orghttps://web.archive.org/web/20120925084346/http://fay-lang.org/website,
one document following a simple pattern from an introduction over
installation notes to the demonstration of some simple examples. Always
wondered why this has been removed.

I know the content is still in the wiki here and the examples (plus many
more) can found in the repo, but I find the information not so accessible
any more, especially when you haven't heard of fay and just want to get an
idea what this is about and how it works.

Maybe we can build a page similar to the first one (github.io or
something), which scrolls down showing some examples. Users might be most
interested how fay can be installed and then how it can be used instead of
writing JS code in their web or node apps.


Reply to this email directly or view it on GitHubhttps://github.com//issues/358#issuecomment-27154549
.

@ajnsit
Copy link
Contributor

ajnsit commented Oct 27, 2013

The Fay IDE was nice as well for quick testing. Any chance of getting it back?

@j-hannes
Copy link

👍

@bergmark
Copy link
Member Author

Sounds like a good idea to merge some of the text into the main page!

It shouldn't be too much work to get the IDE working again. I did some work on it a month ago, it almost works. Anyone want to try to finish the last bits? I can host it once it's running.

@bergmark bergmark changed the title Suggest documentation improvements Suggest documentation improvements here! May 15, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants