search

leap-stc / ClimSim

An open large-scale dataset for training high-resolution physics emulators in hybrid multi-scale climate simulators.
https://leap-stc.github.io/ClimSim/
Apache License 2.0
138 stars 40 forks source link

Avoid duplicate text: README <-> website #50

Closed NoraLoose closed 1 year ago

NoraLoose commented 1 year ago

As discussed in https://github.com/leap-stc/ClimSim/pull/44, it is not optimal that we have text that is duplicated in the README and on the website. A concern is that duplicated docs will very quickly fall out of sync as time goes on.

Ways forward are discussed in https://github.com/leap-stc/ClimSim/pull/44, but were not implemented before the PR was merged.

cisaacstern commented 1 year ago

👋 thanks for opening this

cisaacstern commented 1 year ago

@NoraLoose now that I see the newly-built website, the landing page (intro.md) has a really nice simplicity and directness to it.

What do you think about just making the README look exactly like the current intro.md? This means users will link to the website for even intro material like Quickstart, but one click doesn't seem too burdensome?

cisaacstern commented 1 year ago

One disadvantage is that #23 is a little awkward for the website but IMHO #23 is good idea but not an absolute requirement.

NoraLoose commented 1 year ago

What do you think about just making the README look exactly like the current intro.md? This means users will link to the website for even intro material like Quickstart, but one click doesn't seem too burdensome?

I like that idea! 🙌