hytest-org / hytest

https://hytest-org.github.io/hytest/
22 stars 13 forks source link

open issues for all markdown files needed for JupyterBook TOC #276

Closed amsnyder closed 1 year ago

amsnyder commented 1 year ago

Open and issue for each additional markdown file needed by the JupyterBook TOC so that we can assign people to build this content. This task is related to #118.

gzt5142 commented 1 year ago

I wonder if it would be OK if we just list those files here in a task list rather than a separate issue for each?

First step is to agree on the outline structure -- seems like we've had a couple of ideas here and there... would be nice to get something nailed down. See, for example, the sample outline and choices here:

https://github.com/hytest-org/hytest/issues/268#issuecomment-1492337970

Personally, I think that adding depth to the outline is better than breadth, so I'm a fan of the extra layer (chapter/section/sub-section , rather than just chapter/section)

Given the current TOC, the sub-section container documents we need are:

That's it for now... but as sections get approved for inclusion, some will need to be added, depending on the TOC decisions made to include those new sections. Hard to know what to include now before that material gets written.

Note on the chunk.md doc... It seems like @rsignell-usgs 's documentation project is expected to become a section to include here in place of these two or three files. That's not to say that we don't need this doc now, but just that it will change if/when that other material gets folded into this repo.

gzt5142 commented 1 year ago

Environment Set-Up

Getting Started

Dataset Access

Model Evaluation Tutorials

Supplementary

gzt5142 commented 1 year ago

Some nomenclature:

In the above sample (the current state of the TOC, more or less),