NMFS-RADFish / radfish

Documentation source for docusaurus generated Github Page.
https://nmfs-radfish.github.io/radfish/
1 stars 1 forks source link

Radfish 242 update documentation #8

Closed gambinish closed 3 months ago

gambinish commented 4 months ago

Refresh Documentation - Phase 1

The goal for this PR was to refresh the docs to become up to date with the latest development standards and patterns of the RADFish project as we wrap up the first phase of work.

Ticket: https://apps-st.fisheries.noaa.gov/jira/browse/RADFISH-242

Main changes:

  1. Organize our various design pattern choices under Application Development Guide >> Building Your Application >> Patterns

  2. Give some explanation as to was examples and templates are

  3. Remove outdated references to things like Create React App, localStorage etc.

Additionally we opted to remove things like Regions and UX because for all intents and purposes those were placeholder sections. There were also a few other sections that were not filled out and I removed those as well.

More than happy to go over this again. Once this gets approved I will make sure things are correctly linked from the boilerplate repo.

https://github.com/user-attachments/assets/218dd076-bc40-4849-b7a7-1a58c22678ba