search

nextstrain / docs.nextstrain.org

Umbrella documentation project for Nextstrain
https://docs.nextstrain.org
17 stars 13 forks source link

Versioned resources copyedits #178

Closed tsibley closed 4 months ago

tsibley commented 4 months ago

See commit messages for details.

Related to #177.

Checklist

tsibley commented 4 months ago

@jameshadfield Just a few small edits for consistency which I think are improvements. Overall the document you wrote is a great compact and punchy guide-by-example of the dated snapshots feature!

tsibley commented 4 months ago

Ah, I'll fix that CI warning tomorrow.

tsibley commented 4 months ago

I'm ambivalent about "snapshot" (yes I realise I used it in the overview paragraph) so it'd be good to get some other opinions from the team about what language is best used here. In the (internal facing) code I use "version" and don't want to change that.

Nod. Your usage of "snapshot" there is what made me think about the terminology here for user-facing docs. I think "snapshots" will be clearer than "versions" for typical users and not muddied with the unrelated topic of software versions. Definitely fine to keep using "version" internally.

tsibley commented 4 months ago

First three commits seem good to me.

I've merged those (merge commit be6d3f5779fc73aa5f96143a50bbbe704404c105). Will wait for the remaining two.

tsibley commented 4 months ago

Conclusion at the biweekly all-hands discussion just now was "snapshot", so I've merged.