Skip to content
This repository has been archived by the owner on Nov 6, 2019. It is now read-only.

[docs] widgets need demo examples #350

Open
Bamieh opened this issue Jun 23, 2018 · 3 comments
Open

[docs] widgets need demo examples #350

Bamieh opened this issue Jun 23, 2018 · 3 comments

Comments

@Bamieh
Copy link

Bamieh commented Jun 23, 2018

I've just began exploring this project, it has lovely concepts and architecture behind it.

The documentation on widgets are really missing demo examples, I have to read so much to know what the component does and leave it to my imagination to guess if i need it, or how it would look like.

It would be also nice to have a link in the docs directing back to github, and a link of the github pages from this repo's description.

And finally, when I am inside an api doc (example) I am stuck in there forever, there is no way to go back to the main docs homepage.

@abalter
Copy link

abalter commented Jul 5, 2018

There is a page with some examples, but it is not linked to on the home page.

@dannycodes
Copy link

Further, the examples are out-of-date: the dockpanel example uses the phosphor-dockpanel package, which has a different API

@dannycodes
Copy link

If anyone is still searching, documentation has apparently been added in the examples directory. Note that these docs ARE NOT the same as the ones hosted on the phosphor website.

These ones use the current ( or at least, current enough ) version of the api

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants