saresend
Add Documentation and Examples
It seems to be a good start to enter in the project :)
What do we need exactly?
- [ ] Rust examples in a specific folder at the root
- [ ] A good user guide
I think right now probably the biggest improvement is improving documentation for setting up the selenium side of things, since that's already been a sticking point here. It's a bit broad, but if you feel good about configuring and setting up the selenium server (and adding webdrivers), explaining the procedure a bit more in depth would be wonderful!
Ok, I will look how to improve that 👍 . If we are looking for a step by step guide I recommend a github pages branch. Or I can try to improve the Rust documentation but it doesn't seem to be the right place for this kind of documentation.
I definitely agree, I think I'd rather leave the rust documentation alone for now, especially if it makes sense to split this up into more than one crate. One option that might be a good idea is to look at some of the other language implementation of selenium clients, and look at what documentation they're including: Go, Python
Most of them provide an API documentation. I would like to add something like a "user guide" where we could have examples, step by step explanations, good practices (page object pattern, implicit/explicit waits, ...).
I love how the Diesel documentation is written, or the Rocket one.
But first of all we can start with an "examples" folder and reuse the code later in the documentation (like the Go project) :)