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

User Documentation #21

Open
7 tasks
jantman opened this issue Nov 9, 2016 · 2 comments
Open
7 tasks

User Documentation #21

jantman opened this issue Nov 9, 2016 · 2 comments

Comments

@jantman
Copy link
Owner

jantman commented Nov 9, 2016

Add user documentation:

  • user guide Sphinx page
    • include screenshots, with a tox env to build them (via phantomjs? chrome?)
    • include a short screencast of actually playing the game and showing the major features
  • help page in app itself - start with text of features, and also point to user guide on RTD (point to the specific per-version tag)
  • update features list in README
  • enable RTD, get build working
  • link to that page in README (prominent, near the top, as well as in the "Usage" section where there's now just a ToDo comment) and GitHub repo setting URL
@jantman jantman added the ready label Nov 14, 2016
@jantman
Copy link
Owner Author

jantman commented Nov 15, 2016

I enabled builds on RTD, but the build is failing; need to look into this: https://readthedocs.org/projects/gw2copilot/builds/4667747/

Perhaps also look into: readthedocs/readthedocs.org#1139 (comment)

@jantman
Copy link
Owner Author

jantman commented Nov 17, 2016

Add an FAQ section; first one should be missing map tiles (zoom out and back in; should be fixed with #3)

Also FAQ on caching of GW2 API calls
and on leaving it open in the background when GW2 is closed - GW2 needs to be running before you start it, but it should reconnect

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

1 participant