LDAR-Sim / LDAR_Sim

MIT License

11 stars 22 forks source link

docs: Add V3 to V4 Parameter Migration Guide #215

Closed ThomasGalesloot closed 4 months ago

ThomasGalesloot commented 4 months ago

Pull Request Key Information

Reason for change

Much has changed from LDAR-Sim v3 to LDAR-Sim v4.

What was changed

Created a new document that outlines the key changes in parameters and inputs from v3 to v4.

Intended Purpose

Help users navigate the move to V4

Level of version change required

N/A

Testing Completed

N/A

Target Issue

N/A

Additional Information

N/A

ThomasGalesloot commented 4 months ago

Great job overall!

Instead of another folder for Version Migration Guides, could we rename the Feature Guides folder to Other Guides and move these parameter migration guides in there? I feel like there's too many folders... Also, the User manual section needs to be updated - specifically the section called file structure.

Make new folder guides with subfolder for different guide types. I know the user manual is going to be updated at some point, this will need to be update with it.