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

enhancing documentation #127

Closed
ghost opened this issue Jan 26, 2017 · 1 comment
Closed

enhancing documentation #127

ghost opened this issue Jan 26, 2017 · 1 comment

Comments

@ghost
Copy link

ghost commented Jan 26, 2017

  • This is very dense. How can we simplify it? If we reduce the content, there will be less for people to complain about. For example, maps of the experimental design would be nice but really?
  • We need to make sure that the rest of the team is contributing.
@ghost ghost added the kind/discussion label Jan 26, 2017
@dlebauer
Copy link
Member

We could also split it into different books or sections.

If we compile the documentation using the gitbook cli, we can have different SUMMARY.md files that compile different subsets.

We could have different books, e.g. for

  • Science objectives and data access
    • science objectives
    • data formats / web interfaces
    • tutorials / examples
  • Data transfer and computing pipeline
    • including algorithms, software
    • how to add / development section

Just an idea ... what do others think?

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