max-mapper / max-mapper/voxel-builder

Improve instructions/make a curriculum page

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
CSS
Stars
150
Forks
50
PR merge metrics
No merged PRs in 30d

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing copy and instructions in index.html and edit.html, including the first-launch popup and Export Orthogami and Export Paperstack modals. Done means the front page and in-app guidance are improved for classroom users, with an end-to-end guide added if the existing pages do not cover that workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.