phosphorjs / phosphor

The PhosphorJS Library
BSD 3-Clause "New" or "Revised" License
1.04k stars 169 forks source link

[Docs/Examples] Codesandbox template / Storybook support #414

Open Madhu94 opened 5 years ago

Madhu94 commented 5 years ago

From the standpoint of a beginner, PhosphorJS is not really easy to get up and going with. Do you think it would be a good idea to add storybook support or codesandbox templates for phosphor?

blink1073 commented 5 years ago

I'd love to see storybook examples of the different widgets and layouts, and ideally make them part of the hosted docs.

akosyakov commented 5 years ago

@blink1073 Would you be interested in Gitpodified examples for the repo? I could make a demo PR. Gitpod is built based on top of PhosphorJS as well 😊

We use it to develop and streamline reviews on Theia. It's integrated in GitHub to prepare dev env with a project built for development and spawn it with one click: https://gitpod.io/#https://github.com/theia-ide/theia

freeCodeCamp, Ant Design, GatsbyJS are using it to demo and streamline contributions as well

blink1073 commented 5 years ago

That sounds like a great way to demo examples!

sccolbert commented 5 years ago

As an FYI - there is currently an effort underway to move our docs to ReadTheDocs.

Madhu94 commented 4 years ago

I'd like to pick this up and start adding a few examples, I could really use some examples for myself. @akosyakov I'd love to see examples on Gitpod too !

blink1073 commented 4 years ago

Sounds great @Madhu94.