zephyr-data-specs / GMNS

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

Efficient directory names #63

Closed e-lo closed 6 months ago

e-lo commented 1 year ago

As a programatic user, I'd like to more efficiently navigate the GMNS spec directory and not worry about fussy capitalization.

If approved by community, I (@e-lo) am happy to implement.

Proposed solution

Adopt following folder structure:

spec\
examples\ #small network examples dir...without stray .csvs in base dir
usage\ #example validation and usage notebooks, currently in validation tools and conversion tools dir
docs\ 
  spec\ # all markdown versions of spec
  img\  # all image files
e-lo commented 1 year ago

Note that this structure will also more effectively support a future site with automated documentation generation.

e-lo commented 1 year ago

cc: @joecastiglione on if community would like me to implement.

ssmith55 commented 1 year ago

Thank you for the suggestion. Other users, notably AequilibraE, are using the current directory structure in some examples. I am fine with this change, but would like to save it for the next release, with advance notification to the user community.

pedrocamargo commented 7 months ago

Excellent suggestion

ssmith55 commented 7 months ago

Let's do it, starting with the development (soon to be develop) branch.

ssmith55 commented 7 months ago

Done in the development branch. Now need to check for and fix broken links.
Conversion_Tools -> usage\conversion Images -> docs\img Small_Network_Examples -> examples Specification -> spec Specification_md -> docs\spec Validation_Tools -> usage\validation