max-mapper / max-mapper/voxel-engine

Documentation - VoxelJS

Open
#115 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.3k
Forks
217
PR merge metrics
No merged PRs in 30d

Description

@shama @deathcap

I went a head and created a wiki where we can start working and putting up more collective documentation. Its only a start and we can totally disregard it if you wish. Also, the domain name should probably be changed to something like voxeljs.io etc. or something but it costs to get a better domain name, also we should discuss what it should actually be called, 'voxelwiki' doesnt sound too nice. Once you have made accounts on the wiki I will bump you up to admins so you have unrestricted powers 😄

Contributor guide

Open the contributing guide

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

No source files, tests, or code entry points are identified. Review the proposed wiki and the questions about its domain name and branding first; the work is done only after the project agrees on whether to use it, what to call it, and the documentation scope.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.