chgibb / phatdocs Goto Github PK

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Tighten up language around creating new figures, as there is some redundancy in the section headers (creating new figures, "brand new figure). Could just make it one section perhaps.

Currently says "PHAT can only visualize...". Adjust language to just make it clear that PHAT allows adding of features.

The contents of docs should be available in a side-bar if possible, for quick section jumping

May run into issues with people having to go through lengthy updating cycles if they are many versions out of date. Consider adding a check for # of updates needed to catch up, and options to reinstall latest version (ideally, without losing any project files or info).

What is meant by "little else" when referring to input files and what information is stored? Should tighten up the language and make this more clear. Reading on it seems this is referring to contig information. Should just say explicitly what information is being stored: directory, contig info, and anything else.

Include unpacking instructions, even if just very brief.

It's good to see all the pointing toward issues, however, some users may not be familiar or comfortable with GitHub issue reporting, so may prefer an e-mail link to contact directly. Also, we should have clear issue reporting guide on the GitHub pages if it starts to get busy.

Hey Chris,

Right now it looks like there is no Windows installer on the "latest release" or "latest stable release" pages. I found the installer under the releases tab but it took a bit of digging to find. A link directly to the installer on some of those other release pages would probably be helpful.

Cheers!

Embed high-quality images and animations (GIFs) where possible throughout the documentation

In the "How to get PHAT" section, what directories do Windows and Ubuntu installations automatically install into? Ideally this could be chosen by the user upon installation, but at minimum could let the users know where in the documentation.

To access docs from https://chgibb.github.io/PHATDocs/, the user has to click through the release history, then on a small hyperlink for the version, then the documentation link. Should be more accessible for the latest version, perhaps right on the main page? Not necessarily a problem in PHAT itself, as the Help button leads to the proper directory.

GUI has changed as of 0.4.0-beta.1. Screenshots should be updated to reflect the change.

Consider adding a link to the download/release page in the "How to get PHAT" section

Images not loading on the chgibb.github.io website for Google Chrome.