Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Improve instructions #219

Closed
5 tasks done
2320sharon opened this issue Jan 25, 2024 · 0 comments
Closed
5 tasks done

Documentation: Improve instructions #219

2320sharon opened this issue Jan 25, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@2320sharon
Copy link
Collaborator

2320sharon commented Jan 25, 2024

After a lot of user testing we figured out where users get confused.

Tasks

Tide Correction

  • Update the tide correction instructions in the notebook to tell the user to load a session with extracted shoreline first
  • Update the tide correction instructions that the new tidally corrected files will be saved to their session
  • Update the tide correction instructions that it will overwrite any existing tidally corrected files
  • Update the tide correction instructions to tell users its takes a few minutes for the tide prediction step to finish

General Instructions

  • Tell users to NEVER rename their sessions or ROIs after they've been made
  • Update you actually safely can rename sessions but not the name of the ROIs in the /data folder or within your session

Ideas

  • Have an indicator that shows when ROIs with downloaded data or extracted shorelines have been loaded in

@dbuscombe-usgs if you think of other useful instructions write them here

@2320sharon 2320sharon added the documentation Improvements or additions to documentation label Jan 25, 2024
@2320sharon 2320sharon self-assigned this Jan 25, 2024
2320sharon added a commit that referenced this issue Apr 19, 2024
…tten, what files are generated, and tell users to load a session
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant