Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding explicit examples that show the use of the attributes in EACH example-code #122

Open
StefanL38 opened this issue Jul 13, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@StefanL38
Copy link

StefanL38 commented Jul 13, 2022

Hi,
the headline says it all
adding explicit examples that show the use of the attributes in EACH example-code

The example for the PIR-Sensors has empty attributes
{ "type": "wokwi-pir-motion-sensor", "id": "pir1", "top": -42, "left": 25.81, "attrs": {} },

that is a somehow bad example as it dos NOT explain how to use the attributes
you should add an example that shows all attributes
If you show it like in the picture below a user can learn

  • where to find the attributes (diagram-json-tab)
  • and what syntax the content of the attributes section must have to make it work with multiples attributes (comma-separated

grafik

@urish urish added the documentation Improvements or additions to documentation label Jul 20, 2022
@urish
Copy link
Contributor

urish commented Jul 20, 2022

Thanks for the feedback! For starters, we can add an explainer in diagram format, and link to it from the Attributes section of each part.

@letsgo88
Copy link

7hours later i find your comment and change the anode to a cathode and now everything works. StefanL38 i could kiss ya right now you made my day. I knew what the problem was just had no idea how to edit it, until i read your comment. This is defiantly needed so people don't give up before they find the potential of the site.
and Wokwi if you give your instruction to someone that has never used the site before they will quickly show you if your instruction are good or far to vague.

@matititam
Copy link
Contributor

Hello @letsgo88

I'm glad you were able to find a solution, but it's unfortunate that it took you 7 hours 😓. Can you help us understand how we can improve our documentation and processes to prevent this from happening for new users in the future?

Can you please tell me where(site, forum, particular wokwi guide, or anything) did you try to find the solution to start with? What all options did you explore?

Thanks in advance 😃

@letsgo88
Copy link

letsgo88 commented Jan 26, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants