-
Notifications
You must be signed in to change notification settings - Fork 11
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
Frequently Asked Questions (FAQ's) #23
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I have a few remarks, please solve these and I'll merge the PR. Also, a general issue with the overall FAQ: please remove spaces before question marks (?
).
FAQ's.md
Outdated
@@ -0,0 +1,30 @@ | |||
**Q: What is ADSdroid ?** | |||
|
|||
A: It is the unofficial AllDataSheet Android Application. It gives her users the privilege of searching and downloading electronics tools in pdf format, for easier and faster access |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not the unofficial
but rather an unofficial
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also, gives her users the privilege of searching and downloading
should be makes it possible for users to search and download
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PDF is an acronym, it should be all caps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
electronics tools
is a strange term, datasheets for electronic components
would be better
FAQ's.md
Outdated
|
||
**Q: How do I use it ?** | ||
|
||
A: Very simple. Just input a valid electrical terms in the search box and click on the search button |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
input a valid electrical terms
should be enter the name of the component (can be partial)
FAQ's.md
Outdated
|
||
**Q: What is the drop down-button for ?** | ||
|
||
A: When you click on the drop-down button, you'll see some options(included, start with, end with and match), these are used to make your search results more precise |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please leave a space before the opening parentheses, like options (included
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be a bit more useful if you'd describe the four options in a bulleted list, maybe with some examples like the ATMEGA168
(a typical component whose datasheet someone would search for using this app) could be matched with east of the options, like it includes MEG
, ends with MEGA168
, starts with ATMEGA
, and only matches ATMEGA168
.
FAQ's.md
Outdated
|
||
**Q: How do I get my searched result as PDF ?** | ||
|
||
A: Once you've located a related search, just click on the particular one, it should download on your device and be saved as PDF in your local directory (Downloads folder) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
located a related search, just click on the particular one
should be found the component you were looking for, just tap on it
FAQ's.md
Outdated
|
||
**Q: Where is the source code?** | ||
|
||
A: You can find the app source code on github : https://github.com/dnet/adsdroid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub should be stylized with an uppercase G and H, and strip the space before the colon like GitHub: https://...
FAQ's.md
Outdated
|
||
**Q: I found a bug or issue, what should I do?** | ||
|
||
A: Open a new issue, describing the exact bug/issues so I can fix it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should contain a link to https://github.com/dnet/adsdroid/issues and another sentence maybe asking users to check already reported issues before opening a new issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.... Please review
@dnet please review |
FAQ's updated
@dnet kindly review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of the changes were good, if you can take care of these, I'll merge the PR. Thanks!
@@ -0,0 +1,30 @@ | |||
**Q: What is ADSdroid?** | |||
|
|||
A: It is an unofficial AllDataSheet Android Application. It gives her users the privilege of searching and downloading datasheets for electronic components in PDF format, for easier and faster access |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gives her users the privilege of searching and downloading
should be makes it possible for users to search and download
|
||
**Q: How do I use it?** | ||
|
||
A: Very simple. A valid electrical terms should be entered, the name of the component (can be partial) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The second sentence should start with Just enter the name of the component (can be partial)
(the rest is OK)
|
||
**Q: How do I get my searched result as PDF?** | ||
|
||
A: Once you've located a related search, just click on the particular one should be found the component you were looking for, just tap on it, it should download on your device and be saved as PDF in your local directory (Downloads folder) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove located a related search, just click on the particular one should be
so it reads Once you've found the
...
|
||
**Q: I found a bug or issue, what should I do?** | ||
|
||
A: Open a new issue on https://github.com/dnet/adsdroid describing the exact bug/issues so I can fix it. Kindly check if there is a similar issue regarding yours, to see the solution |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Kindly check there is
should be Please check if there is
This file contains the possible frequently asked questions and the answers