Skip to content
This repository has been archived by the owner on Feb 28, 2021. It is now read-only.

Example and Example Styled - make it just one? #115

Open
1 task done
mithru opened this issue Aug 17, 2018 · 2 comments
Open
1 task done

Example and Example Styled - make it just one? #115

mithru opened this issue Aug 17, 2018 · 2 comments
Assignees

Comments

@mithru
Copy link
Collaborator

mithru commented Aug 17, 2018

Nature of issue?

  • Existing feature enhancement

Feature enhancement details:

Going back to #54 and #101 , on the discussion about making it easy for first timers to try the library, should we try to make it one folder instead of two? Similar to the change in #101 . Currently the only difference seems to be the visibility of the part that's screen-read.

This would be my proposed folder structure:

Examples folder would have just these files (ignore the names - they're just samples to illustrate my point):

./index.html
./app.js
./basicShapes.js
./basicLines.js
./anotherExample.js
./yetAnotherExample.js

With the following changes:

  1. index.html would have the css to display the different modes, but with a comment that would change to display:none

  2. index.html would also have just app.js (probably renamed) uncommented, but all other files i.e. basicShapes.js , basicLines.js , et al commented with a prompt to users to uncomment the file they wish to see.
    OR
    just have app.js and a prompt for users to edit app.js in the code to basicShapes.js or the file they wish to try.

@spiray
Copy link
Contributor

spiray commented Aug 17, 2018

@mithru I think this is definitely better than what we have now. However, we can make it more beginner friendly in the sense that we can make it all in the UI. We can have different tabs or buttons to select different examples. This would obviously be a bigger project and I will leave it to @MathuraMG and @lm-n on what the priority is but this will be worth it in the long run.

@lm-n
Copy link
Member

lm-n commented Aug 17, 2018

Yes this is a great idea and actually it is pretty high up our priority list. Let's talk about UX/UI design for this next week during our call!

@mithru mithru self-assigned this Aug 23, 2018
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