search

aatxe / irc

the irc crate – usable, async IRC for Rust
Mozilla Public License 2.0
535 stars 100 forks source link

Document the IRC protocol (as best effort). #106

Open aatxe opened 6 years ago

aatxe commented 6 years ago

Lately, I've been going through and trying to improve the project docs as much as possible (and I think they've gotten a lot better!). One notable deficiency to me is that much of the protocol specifics (like the documentation for Command, Response, and Capability) simply link to the specifications that describe them. I don't think it's feasible (at least not currently) to replicate all of the specifications, but I think it would be useful for API consumers to capture more detail about the protocol itself in the documentation. Most people who are interested in writing an IRC bot (i.e. most library users) probably don't know a lot of the nitty-gritty of IRC, and it'd likely be helpful to pull some of that into our docs.

I'll be working on this progressively as I have time, but if anyone wants to contribute more documentation (or give feedback on existing documentation, both of the IRC protocol and of the library in general), that would be very appreciated!

aatxe commented 6 years ago

Just a note: I removed help wanted only because everything here that's open is "help wanted." 😄 If anyone is interested in contributing docs, horse docs is probably the place to start! Even just adding direct links there and a bit of prose would be helpful.