max-mapper/voxel-builder

Improve instructions/make a curriculum page

Open

#18 opened on Jul 12, 2014

View on GitHub
 (0 comments) (0 reactions) (0 assignees)CSS (50 forks)github user discovery
help wanted

Repository metrics

Stars
 (150 stars)
PR merge metrics
 (PR metrics pending)

Description

@lyle @tmpvar @brycebaril @darkroastruth I did a first pass at Export > Orthogami and Export > Paperstack in the app, try it out on http://voxelbuilder.com/

I think we need better instructions though, ideally a sort of guide that is targeted at people who want to use this in classroom settings

Some stuff to work on if anyone wants to help w/ this issue

  • improve front page copy (index.html)
  • improve pop-up instructions that come up the first time you launch the builder (edit.html)
  • add instructions to the Export Orthogami and Export Paperstack modals (edit.html)
  • if it makes sense make a whole new page that is an end-to-end guide

Contributor guide

Research direction
Review existing index.html and edit.html files. Study the app's Export > Orthogami and Export > Paperstack features to write clear instructions. Optionally design a new curriculum page.
Tech stack
htmlcssjavascript
Domain
frontendweb dev
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTMLCSSGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80