-
Notifications
You must be signed in to change notification settings - Fork 780
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
Updated examples in Readme #131
Conversation
The code said actions: {} but the codepen says reducers: {} So, updating the readme to be in sync with the actual working code.
Codecov Report
@@ Coverage Diff @@
## master #131 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 4 4
Lines 171 171
=====================================
Hits 171 171 Continue to review full report at Codecov.
|
So I'm just using hyperapp today. I think I remember things in the wiki need revisions too. |
Hi @jamen! Yep. Going through those too as we speak. The CodePen examples are out of date because I haven't released 0.7.0, but I intend to do that very soon too. |
@jamen That's actually a good point against using the wiki. If we move the docs to master they will always fit the revision you checked out in git. |
@dodekeract I don't think the most common use case for hyperapp is to clone the repo. I prefer a wiki (and will use a wiki from now on in future projects too). This is a decision I reached after more than 200 commits to the now-deprecated user manual and weighing cons and pros in my head. The main reasons I favor public wikis are:
There may (likely going to) be a website for hyperapp in the future. I think the website can and should be used as a marketing device. It's okay to show benchmark results, tell that hyperapp is cool, show examples, talk about its features, etc. The repo, however, should avoid all sort of opinionated stuff like that and focus on what the project is, what it does, include examples and easy to access / update, no-nonsense documentation. |
@jbucaran The use-case isn't to "clone the repo" the use case is to be able to work with older versions of hyperapp without knowing every single detail. There'll be issues when we switch from v1 to v2 since we have to destroy the old wiki.
What do you mean? |
No idea what that means. |
Okay, I see what you mean. Hyperapp v1, then v2 changes everything and there would be no v2 documentation. |
@jbucaran I actually mean the opposite. We release |
🤔 I didn't consider that possibility. That definitely poses an interesting problem. I think this particular project has the potential to avoid that scenario, as I hope to lock/freeze the API with 1.0. If there's a 2.0 there may be new features, but no removal of older ones. This is not something I'm really worried about at the moment, but thanks for opening my eyes. |
not really, IMO, vue and angular actually have some big changes between v1 and v2, you can not always control what software is going on...however, wiki is a good place to place some tutorial that explains concepts and architecture, which mostly will not change between versions, to help users and contributors to undersatnd repo, but api need another place like standalone website. |
The code said
actions: {}
but the codepen saysreducers: {}
So, updating the readme to be in sync with the actual working code.