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

Lack of Documentation #37

Open
horrido opened this issue Dec 21, 2014 · 6 comments
Open

Lack of Documentation #37

horrido opened this issue Dec 21, 2014 · 6 comments
Milestone

Comments

@horrido
Copy link

horrido commented Dec 21, 2014

The lack of documentation, especially with respect to how to write Amber applications, is severely restricting newcomers (like myself) who want to try out Amber. There are no decent tutorials beyond the trivial "Hello World" or Counter app. Any examples that I've found have been too narrowly focused or specialized. In particular, there is precious little information on how to work with HTML and DOM elements (eg, how to work with forms). Amber seems to rely heavily on jQuery, so if this is the case, the documentation should explain how to go about interfacing with jQuery (and tell the reader that jQuery knowledge is mandatory).

@ghost
Copy link

ghost commented Dec 21, 2014

Interfacing with jQuery is simply: "use asJQuery to obtain jQuery set and then just work with it using smalltalk selector to access property / call a method".

As you @horrido said in ML you are retired writer w/ lots of time, do you care to be part of the documentations / examples team?

@horrido
Copy link
Author

horrido commented Dec 22, 2014

Yes, I'd like to be part of the team. I will feel more confident about
contributing once I figure out how to write a proper Amber application.

On 21 December 2014 at 15:49, Herbert Vojčík notifications@github.com
wrote:

Interfacing with jQuery is simply: "use asJQuery to obtain jQuery set and
then just work with it using smalltalk selector to access property / call a
method".

As you d @horrido https://github.com/horrido said in ML you are retired
writer w/ lots of time, do you care to be part of the documentations /
examples team?


Reply to this email directly or view it on GitHub
#37 (comment)
.

@hhzl
Copy link
Member

hhzl commented Dec 23, 2014

@horrido Richard, you mention as examples

  • Hello Word App (now generated by amber init, so earlier explanations are obsolete)
  • Counter

There are more examples in https://github.com/amber-smalltalk/amber-examples
and there is a ToDo app https://github.com/hhzl/Amber-ToDo-List

I suggest that you have a closer look at them and see if you can convert something to a tutorial.

@hhzl
Copy link
Member

hhzl commented Dec 23, 2014

See also current work at https://github.com/philippeback/amber-book

@hhzl
Copy link
Member

hhzl commented Dec 23, 2014

@sebastianconcept
Copy link

I'm reviewing the information architecture of these docs.
Many problems found.
We need to address coordinating efforts

@horrido can you check the email I've sent to the google group regarding to this? Thanks!

Also I take your offer on helping to review the copywriting.
Many of us are non-native english speakers and highly technical profile so I found lots of communication catastrophes all around.

We need to do better if we want to get somewhere

@hhzl hhzl added this to the 0.14 milestone Jan 9, 2015
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

3 participants