phetsims / phetsims/binder

Next steps for Style Guides and Binder

Open
#5 4 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
0
Forks
4
PR merge metrics
No merged PRs in 30d

Description

This week @zepumph and I created an initial draft for Binder, which combines hand-written markdown documentation with automatically generated information about component usage. The results are published on https://phetsims.github.io/binder/

Currently, we are only including information on Checkbox, ComboBox and HSlider, though it would be easy to add other components.

@amanda-phet the markdown files are located in https://github.com/phetsims/sun/tree/master/docs . Can you please review them, update them and review https://phetsims.github.io/binder/ to see what else should be done at the moment?

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.