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

Improve documentation for users and developers #164

Closed
jyeatman opened this issue Oct 24, 2017 · 6 comments
Closed

Improve documentation for users and developers #164

jyeatman opened this issue Oct 24, 2017 · 6 comments
Assignees
Milestone

Comments

@jyeatman
Copy link
Member

AFQ-Browser documentation should be improved to include more information to support other developers in incorporating AFQ-Browser into their software projects.

@jyeatman jyeatman added this to the revision milestone Oct 24, 2017
@arokem
Copy link
Collaborator

arokem commented Oct 26, 2017

Use doctr to automate documentation build

We do also need to add content:

  • Data specification.
  • How would I use this with data from another software (not AFQ)?
  • How would you contribute to this project?
  • Python API
  • What are things that you can switch out, if you want to?
  • Link to the preprint (and eventually to paper)
  • What are the moving pieces in the Javascript part ( @richford )?
  • I want to add an AFQ-browser into my lab website. How do I do that?
  • How do I cite the AFQ-browser project

@richford
Copy link
Collaborator

@anotherjoshsmith and I should write documentation for each js file.

@richford
Copy link
Collaborator

javascript documentation added in #226 and #228.

@arokem
Copy link
Collaborator

arokem commented Dec 19, 2017

People shouldn't put these on their lab website, because it would break afqvault and binder.

@arokem
Copy link
Collaborator

arokem commented Dec 19, 2017

OK - all of these are handled in #234, which I believe is now ready to go!

@richford
Copy link
Collaborator

Resolved by #252.

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

4 participants