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

distill duplicate sections of documentation #1347

Closed
cchriste opened this issue Jun 23, 2021 · 1 comment
Closed

distill duplicate sections of documentation #1347

cchriste opened this issue Jun 23, 2021 · 1 comment

Comments

@cchriste
Copy link
Contributor

In general, there are lots and lots of cut-and-pasted pages or subsections thereof in the docs, for example in the Use Case descriptions. Is it possible there is a better way to organize these use case descriptions? They may not all be identical, but if a user has gone through a couple of them they'll be skimming the things they've read before and very likely miss any differences.

A shared section might instead summarize and each use case description note any differences.

@iyerkrithika21
Copy link
Contributor

For each use case include three sections:

  1. What is this use case demonstrating? what is different/new?
  • Explain the features of the input data
  1. Reference output
  2. Default optimization parameters

One page explaining all the tags available for the use cases.

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