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

Documentation issues #8

Open
5 tasks
ShadowNinja opened this issue Oct 18, 2015 · 1 comment
Open
5 tasks

Documentation issues #8

ShadowNinja opened this issue Oct 18, 2015 · 1 comment

Comments

@ShadowNinja
Copy link

  • 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.
@SkyzohKey
Copy link

👍 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).

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

No branches or pull requests

2 participants