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.

Sign up for GitHub

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

Jump to bottom

Examples documentation #480

Open
geovanisouza92 opened this issue Nov 29, 2016 · 7 comments · May be fixed by #880
Open

Examples documentation #480

geovanisouza92 opened this issue Nov 29, 2016 · 7 comments · May be fixed by #880
Labels
hacktoberfest help wanted issue is feature suggestion priority 1 (maybe) scope: misc

Comments

@geovanisouza92
Copy link

It would be really useful to have a reference about what each example have and demonstrate.
@dmitriz
Copy link

dmitriz commented Dec 20, 2016

Ported from discussion with @staltz on Gitter

These are basic examples:

  • counter
  • hello-world
  • checkbox
  • bmi-naive
  • http-random-user

And these are Intermediate:

  • hello-lastname
  • bmi-typescript
  • animation
  • http-search-github

The others are advanced I presume

@staltz
Copy link
Member

staltz commented Dec 21, 2016

This is a good task for someone studying Cycle.js to contribute back:

  • Make a README.md file for each example directory
  • Write an overview of how it works in that README.md

@dmitriz
Copy link

dmitriz commented Dec 21, 2016

Not a readme (yet) but some of the most (over-)zealous comments I've ever written ;)
#500

This was referenced Oct 3, 2017
Closed
Merged
Merged
@IssueHuntBot
Copy link

@issuehuntfest has funded $40.00 to this issue. See it on IssueHunt

@rahgurung
Copy link

Hey ! I am studying CycleJS can I work on this issue ? Are the examples written ? and I just have to properly document it ? @jvanbruegge @staltz

@jvanbruegge
Copy link
Member

@gurungrahul2 yes to all questions. The goal is basically to add comments inline and in the Readme about what the examples do and how they do it

janat08 added a commit to janat08/cyclejs that referenced this issue Mar 24, 2019
@janat08
Examples menu document
0353889 
cyclejs#480
@janat08 janat08 linked a pull request Mar 24, 2019 that will close this issue
Open
@janat08
Copy link

janat08 commented Mar 24, 2019

One does argue that as stopgap measure a simple menu suffices until the mega example comes along in #851.

janat08 added a commit to janat08/cyclejs that referenced this issue Mar 25, 2019
@janat08
Examples menu document
13d717a 
cyclejs#480
s
janat08 added a commit to janat08/cyclejs that referenced this issue Mar 25, 2019
@janat08
Examples menu document
c1af58a 
cyclejs#480
janat08 added a commit to janat08/cyclejs that referenced this issue Mar 28, 2019
@janat08
Examples menu document
9ac7121 
cyclejs#480
Update README.md
janat08 added a commit to janat08/cyclejs that referenced this issue Apr 26, 2019
@janat08
Examples menu document
13d35ef 
###--------------------------------------------------------###
docs(examples): examples menu document

Surmised various example applications, and described principles demonstrated in simple examples.

ISSUES CLOSED: cyclejs#480
###--------------------------------------------------------###
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hacktoberfest help wanted issue is feature suggestion priority 1 (maybe) scope: misc
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Examples menu document janat08/cyclejs
7 participants
@staltz @geovanisouza92 @jvanbruegge @dmitriz @janat08 @rahgurung @IssueHuntBot