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

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

Open
aatxe opened this issue Dec 25, 2017 · 1 comment
Open

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

aatxe opened this issue Dec 25, 2017 · 1 comment
Assignees
Labels

Comments

@aatxe
Copy link
Owner

aatxe commented Dec 25, 2017

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
Copy link
Owner Author

aatxe commented Jun 18, 2018

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.

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

No branches or pull requests

1 participant