question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve the "examples" section

See original GitHub issue

I would like to improve the examples section of the project, for different reasons:

  • the first time I started to look into Style Dictionary, I looked at the folder, but it was not clear to me how to use it, and what I was looking at (e.g. the npm folder, what does it mean “npm” in that context?)
  • the “complex” example is quite large, but not really exhaustive
  • probably some of the examples could be updated, to use the latest changes we introduced and show how they work Also, when I was developing new features/adding fixes or updating the tests suite, I would have loved to have a “standard” set of token files that I could use as a playground to test the changes (I had to create this one), to see that I was not breaking anything, and also as input for the snapshot testing (introduced in #133) that could cover all the possible cases and variants.

@dbanksdesign @chazzmoney what do you think? and what do you prefer? that we discuss the possible improvements here, or that I start with opening a PR to show you what I have in mind and we continue the discussion there?

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:12 (11 by maintainers)

github_iconTop GitHub Comments

2reactions
dbanksdesigncommented, Jan 29, 2019

I think we can close this, @didoo @davixyz @chazzmoney @blackfalcon thoughts?

1reaction
chazzmoneycommented, Sep 28, 2018

I think we could improve here too and I like all of your concerns / suggestions. If you have something in mind, feel free to open a PR on it - I think starting with the code ends up producing faster results in the project.

Read more comments on GitHub >

github_iconTop Results From Across the Web

17 areas of improvement examples every manager should know
17 areas of improvement examples that you may have overlooked · 1. Integrity · 2. Initiative · 3. Ambition · 4. Time management...
Read more >
20 Areas of Improvement for Employees | Indeed.com
Areas of improvement for employees · 1. Time management · 2. Customer service · 3. Teamwork · 4. Interpersonal skills · 5. Communication...
Read more >
What to write for areas of improvement on a performance ...
What are some example “areas of improvement” applicable to many roles? Soft skills like communication, collaboration, time management, and ...
Read more >
5 Continuous Improvement Examples You Need to Know
With a continuous improvement example, as well as techniques, this article will showcase how you can help your business operate better.
Read more >
25 Best Examples Of Effective FAQ Pages
FAQ pages continue to be a priority area for SEO and digital marketing professionals. An FAQ page is one of the simplest ways...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found