Docs

[ebgoldstein]

Right now, this issue is just a list of things needed to explain the project.. I think a comprehensive readme would work well.

this will help prevent me making mistakes/mess up your hard work... like yesterday, when i tried to swap in the new Hx Isaias data and it didn't working... 😆

[ebgoldstein]

How map can evolve with added data

• where the files should be added in the directory structure
• which lines of code need to be modified to add this data to the map (unless it is all dynamic and map will render based on whichever data is in a given directory).

specifically, the data that will be added:

• new storms (i.e., adding new storms to dropdown menu)
• NOAA tiles for new storms (WMTS)
• USGS overwash predictions, for both new storms and old storms, as data is released (.shp + .dbf`)
• USGS overwash extents, for both new storms and old storms, as data is released (.shp)
• new/updated ML predictions, for both new storms and old storms (.csv)

[ebgoldstein]

how to use the code:

• general documentation on code structure
• how someone could change modify things.
• how to build/run on a local machine

[ebgoldstein]

what do you think about this @jamisonvalentine ?

[jamisonvalentine]

@ebgoldstein pushed some changes to the README that I did earlier to a new "docs" branch, is there anything that I should add or modify?

[ebgoldstein]

this looks good to me. I would just add the 'file naming convention' info then we can merge that branch... (I will give it a test sometime in the next week — but i think we can merge now regardless since it makes sense to me for sure)