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 #31

Open
15 tasks
slimsag opened this issue Feb 13, 2016 · 3 comments
Open
15 tasks

Documentation #31

slimsag opened this issue Feb 13, 2016 · 3 comments
Assignees
Labels
Milestone

Comments

@slimsag
Copy link
Member

slimsag commented Feb 13, 2016

This should include extensive documentation, including at least:

  • A tutorial / walkthrough.
  • DOM Operations
  • Components
  • Rendering (+rendering nothing)
  • Diffing
  • Safety
  • Sharing code between frontend/backend
  • Communicating with a REST endpoint.
  • FAQ (Why Vecty doesn't support SSR, whether or not it's being used in production).
  • Recommendation about server<->browser data transfer
  • How to test Vecty projects
  • Styling components (if we use non-std-CSS architecture)
  • Live code reloading / asset embedding
  • Redux pattern standard, dispatcher package usage.

Things that commonly trip people up which would also be good to discuss somewhere:

  • An example about DefaultValue for <input>.
@slimsag slimsag added the docs label Feb 13, 2016
@slimsag slimsag self-assigned this Feb 13, 2016
@ghost
Copy link

ghost commented Mar 11, 2016

:) Even just the briefest would be cool..

@anxiousmodernman
Copy link

anxiousmodernman commented Apr 2, 2017

I've sketched a very basic "hello world" tutorial here: https://github.com/gloriousfutureio/vecty/blob/31_docs/docs/TUTORIAL.md

The tutorial should focus on Vecty concepts and be short

  • no external css/js
  • demonstrate Component declaration, reuse
  • demonstrate how components are just structs, use custom fields
  • demonstrate conditionals
  • basic state management?

I'm a fan of go-kit's approach with their stringsvc tutorial. We can start smaller than that.

I'm still new to Vecty and gopherjs myself, so I figured I could write some docs as I go.

@anxiousmodernman
Copy link

@slimsag Has an outline for docs contribution on the docfest branch https://github.com/gopherjs/vecty/blob/docfest/docs/index.md#vecty-introduction

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

No branches or pull requests

2 participants