vecty
vecty copied to clipboard
Documentation
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>
.
:) Even just the briefest would be cool..
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.
@slimsag Has an outline for docs contribution on the docfest branch https://github.com/gopherjs/vecty/blob/docfest/docs/index.md#vecty-introduction