toxme icon indicating copy to clipboard operation
toxme copied to clipboard

Documentation issues

Open ShadowNinja opened this issue 10 years ago • 1 comments

  • [ ] The install documentation only gets you as far as having some source on your computer.
  • [ ] pip install -r misc/requirements.txt is listed twice as a distro specific command.
  • [ ] It doesn't mention using a virtualenv to keep requirements from conflicting.
  • [ ] The config documentation is missing "dns_hostmaster".
  • [ ] The lookup response format is documented far away from the request documentation, with no links to the section.

ShadowNinja avatar Oct 18 '15 21:10 ShadowNinja

:+1: The doc is really messy. The JSON that can be sent to the api is not valid (having to remove action (id) from the code block is stupid, this is not a part of the json code so it should not be into the code block).

SkyzohKey avatar Oct 18 '15 21:10 SkyzohKey