zephyr-data-specs / GMNS

General Modeling Network Specification
https://zephyr-data-specs.github.io/GMNS/
104 stars 15 forks source link

Develop test pages #86

Closed ianberg-volpe closed 1 month ago

ianberg-volpe commented 1 month ago

just testing the GitHub pages deployment -- had to make one tweak to the action to fix an error message (I'm fine with testing the site using the real link since we haven't posted it anywhere yet)

@ssmith55 @dtemkin-volpe take a look at https://zephyr-data-specs.github.io/GMNS

dtemkin-volpe commented 1 month ago

Looks good to me!

ssmith55 commented 1 month ago

It looks nice. But, I fear that if this is the first thing a new user sees, they will be confused. (e.g., we are diving straight into the config file) Perhaps Diego and I can work on it next week to provide some more context

It might help to simply rearrange some things in this readme.md. First a brief general description, then the tables, then the details on the tables?
https://github.com/zephyr-data-specs/GMNS/tree/develop-test-pages/docs

dtemkin-volpe commented 1 month ago

I made changes to the ordering of the docs README.md file and the navigation order, but it seems like the file could use some general rewriting.