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.

Can you improve the documentation?

See original GitHub issue

Hey, Thank you for a good product!

Can you make clearer some details in the documentation?

For example

What user should write to accessories config for example?

Is accessories.*.accessory for some standard names user should copy from? Is accessories.*.name should be uniq for single homebridge instance? What are platforms, though? 😉

Add please link to wiki to readme. You know, Many of repos has empty Wiki enabled by default.

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:7

github_iconTop GitHub Comments

shamasiscommented, Jun 26, 2019

I second this. Firstly this is a great project. I’m super grateful for the developers who have got this to the world.

I’ve been trying to build a lot of home bridge plugins. My only source of documentation is reading other plugins. I’m not asking about simple how-to. I’m looking for simple lists … what are the characteristics available, what are the services, etc. Guess, it’s time to read homebridge code to find that. 😞

stale[bot]commented, Dec 23, 2019

This issue has been automatically marked as stale because it has not had recent activity, and will be closed if no further activity occurs. If this issue was overlooked, forgotten, or should remain open for any other reason, please reply here to call attention to it and remove the stale status. Thank you for your contributions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

5 Tips for Improving Documentation | CloudApp Blog
Effective documentation improves workplace productivity and efficiency. Think about it: easy to understand documents help new employees learn their jobs faster.
Read more >
10 Tips to Improve Technical Documentation Skills
Think of the target audience. Technical writing has a specific audience. · Know the product inside and out · Think of the right...
Read more >
How to improve my documentation skills - Quora
In like manner, the best way to improve your documentation skills is to make use of a self-serve knowledge base software to create...
Read more >
10 things you can do to create better documentation
#1: Document with pictures if possible ... The old adage a picture is worth a thousand words means that by using pictures to...
Read more >
Best Practices that Improve the Quality of Documentation
Best Practices that Improve the Quality of Documentation · Navneet Vats · Create a Robust Documentation Roadmap · Use Plain Language · Benefits...
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 Post

No results found

github_iconTop Related Hashnode Post

No results found