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

better docs #33

Closed
ThomasWaldmann opened this issue Nov 21, 2014 · 4 comments
Closed

better docs #33

ThomasWaldmann opened this issue Nov 21, 2014 · 4 comments
Milestone

Comments

@ThomasWaldmann
Copy link
Contributor

quickstart section misses quite some infos.

@ThomasWaldmann
Copy link
Contributor Author

pull request #36 adds some docs for config file usage, but it has only the most fundamental params.

@ThomasWaldmann
Copy link
Contributor Author

some ideas about the README.rst:

I think there is too much stuff in it right now. People who are deeply interested shall read the documentation, not just the readme. But the readme's task is to GET people interested within a minute.

Like "what is dyndnsc and why do I want to use dyndnsc rather than some similar software?".

This stuff can be included as "about" section into main documentation btw, so one can avoid any duplication.

See there at the bottom for an example what I mean: https://github.com/nsupdate-info/nsupdate.info

@infothrill
Copy link
Owner

note to self: remove list of compatible services and point users to --list-presets. Also document how to add new presets.

infothrill added a commit that referenced this issue Feb 15, 2015
@infothrill
Copy link
Owner

Not perfect but loser than before. Feel free to add more compelling text.

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

No branches or pull requests

2 participants