docs: 📝 update readme and release notes

README.md

@@ -8,7 +8,7 @@
 - [Screenshots](#screenshots)
 - [Installation](#installation)
 - [Usage](#usage)
-- [Previous Versions](#previous-versions)
+- [Release Notes](#release-notes)
 - [Contributors](#contributors)
 - [License](#license)
 
@@ -52,18 +52,27 @@ The feature set rivals those of expensive toolkits, such as AGI's STK, and inclu
 # Screenshots
 
 <!-- white border -->
+<div style="border: 1px solid white;">
+    <img src="./docs/5.jpg" align="center" style="width: 100%; height: 400px;">
+</div>
 <div style="border: 1px solid white;">
     <img src="./docs/1.jpg" align="center" style="width: 100%; height: 400px;">
 </div>
 <div style="border: 1px solid white;">
     <img src="./docs/2.jpg" align="center" style="width: 100%; height: 400px;">
 </div>
+<div style="border: 1px solid white;">
+    <img src="./docs/6.jpg" align="center" style="width: 100%; height: 400px;">
+</div>
 <div style="border: 1px solid white;">
     <img src="./docs/3.jpg" align="center" style="width: 100%; height: 400px;">
 </div>
 <div style="border: 1px solid white;">
     <img src="./docs/4.jpg" align="center" style="width: 100%; height: 400px;">
 </div>
+<div style="border: 1px solid white;">
+    <img src="./docs/7.jpg" align="center" style="width: 100%; height: 400px;">
+</div>
 
 # Installation
 
@@ -99,8 +108,14 @@ Any modifications to a satellite require that information to be passed to the po
 
 There are Typescript files for generating TLE.json that are not included, but http://keeptrack.space/tle/TLE2.json can be referenced for an up-to-date catalog.
 
-# Previous Versions
+# Release Notes
 
+- Version 10.0 - [Euclid](./docs/v10.0.md)
+- Version 9.1 - [Kepler](./docs/v9.1.md)
+- Version 9.0 - [Kepler](./docs/v9.0.md)
+- Version 8.2 - [Phoenix](./docs/v8.2.md)
+- Version 8.1 - [Phoenix](./docs/v8.1.md)
+- Version 8.0 - [Phoenix](./docs/v8.0.md)
 - Version 7.2 - [Nebula Navigator](./docs/v7.2.md)
 - Version 7.0 - [Vega Viewpoint](./docs/v7.md)
 - Version 6.0 - [Celestial Symphony](./docs/v6.md)

docs/CHANGELOG.md

@@ -2,6 +2,118 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
+#### v10.0.0
+
+>  
+
+- feat: :sparkles: add satellite-timeline plugin
+- feat: :sparkles: add timeline feature
+- refactor: :recycle: abstract away common elements of sesnor-fov-mesh/factory
+- feat: :sparkles: update satellite fov menu
+- feat: :sparkles: add radar domes
+- feat: :sparkles: add settings and download buttons to look-angles and multi-site-looks
+- refactor: :fire: remove markers for sensor fov and surv
+- refactor: :recycle: split methods in SensorFovMesh class
+- feat: :sparkles: improve sensor management and menus to incorporate radarDomes
+- feat: :construction: add cone mesh and coneFactory
+- feat: :wastebasket: deprecate marker logic
+- fix: :bug: fix cone mesh only hitting surface of earth
+- chore: :art: update logos
+- feat: :sparkles: add settings menu to multi-site looks
+- chore: :card_file_box: update databases
+- feat: :sparkles: add settings sub-menu to plugins
+- refactor: :recycle: refactor sensor-fov-mesh-factory to remove duplication and deprecated methods
+- feat: :sparkles: update keyboard shortcuts to align with kerbal
+- fix: :zap: fix long loop through markers looking for satellites
+- feat: :sparkles: update camera keyboard controls to match kerbal
+- feat: :art: update icons and logos
+- feat: :sparkles: add scc num and time to polar plots
+- fix: :bug: fix cone's not lining up prefectly with a satellite
+- feat: :sparkles: update look angles logic and add type column
+- refactor: :truck: rename customMeshFactory to sensorFovMeshFactory
+- refactor: :recycle: consolidate selectsat manager logic
+- feat: :sparkles: improve radarDomes
+- fix: :bug: catch edge case where some plugins not loaded
+- feat: :art: replace all icons
+- feat: :sparkles: update keyboard shortcuts for sensor-list
+- feat: :sparkles: add math for new look angles logic
+- fix: :bug: fix resizing of timeline window
+- feat: :sparkles: add searching by alt name
+- refactor: :coffin: disable satelliteFov until I have a working mesh solution instead of markers
+- feat: :sparkles: update keyboard shortcuts for sat-info-box
+- feat: :sparkles: add createRadarDome calls
+- feat: :sparkles: add ctrl+b to toggle bottom menu open/close
+- chore: :card_file_box: update sensors paramaters
+- feat: :sparkles: add keyboard shortcut for satelltie FOV cones
+- feat: :sparkles: update keyboard shortcuts for stereo map
+- fix: :bug: fix polar plot overwriting canvas
+- feat: :sparkles: update keyboard shortcuts for polar plot
+- feat: :sparkles: update keyboard shortcuts for debug menu
+- feat: :sparkles: remove markers changed cb from sensor fov and surv
+- feat: :sparkles: update keyboard shortcuts for night toggle
+- test: :white_check_mark: fix testing environment
+- fix: :bug: fix side menu sub menu width override not working
+- fix: :bug: fix keyEvents not firing
+- fix: :bug: reenable satelliteFOV plugin
+- refactor: :recycle: refactor camera logic out of mouse input
+- feat: :sparkles: add uuid to custom and stf sensor objNames to differentiate them
+- refactor: :recycle: type settingsSideMenu in multi-site-look-angles
+- feat: :sparkles: update splash screens
+- refactor: :art: update css to make dividers thicker
+- fix: :bug: fix hide UI shortcut not working initially
+- feat: :sparkles: add resize event
+- fix: :bug: fix default isDraggable settings
+- refactor: :truck: rename SensorFovMeshFactory filename
+- fix: :bug: fix wathlist overlay being enabled incorrectly
+- fix: :art: fix logo being oversized
+
+#### v9.1.0
+
+>  
+
+- fix: :bug: fix issue with godrays breaking after screen resize
+- fix: :bug: fix issue with godrays breaking after screen resize
+- refactor: :rotating_light: migrate to eslint for formatting
+- chore: :card_file_box: update database files
+- fix: :zap: fix performance bug and css issues
+- chore: :card_file_box: update data
+- feat: :sparkles: add polar plots
+- feat: :sparkles: add new quick reports
+- fix: :ambulance: fix one bad satellite breaking website
+- chore: :card_file_box: update databases
+- chore: :card_file_box: update database
+- fix: :bug: fix logic on waitForCruncher
+- feat: :sparkles: add aer report
+- feat: :sparkles: add sun angle to bestpass report
+- fix: :bug: multiple bug fixes related to color buffer updates
+- fix: :ambulance: fix new launch plugin
+- refactor: :recycle: update settings methods to identify private funcs
+- fix: :zap: reduce impact of godrays on performance
+- fix: :bug: fix conflict between custom sensors and normal sensors
+- test: :white_check_mark: fix broken tests
+- feat: :sparkles: add save button to polar plots
+- fix: :bug: fix reference orbits not updating correctly
+- fix: :bug: fix line to sun/moon in sensor info for custom sensors
+- fix: :bug: fix sun/moon line
+- build: :arrow_up: bump ootk
+- feat: :sparkles: add inFOV color to group color scheme
+- fix: :zap: remove unnecessary color buffer update
+- fix: :bug: fix how isSensorSelected works
+- fix: :lipstick: fix resize cursor icon on draggable menus
+
+#### v9.0.3
+
+>  
+
+- fix: :bug: fix error when sensor reset and planetarium is open
+- feat: :sparkles: add responsive design
+- refactor: :technologist: add version number to error handler for easier debugging
+- docs: :memo: update changelog
+- fix: :bug: fix canvas resizing issue on mobile
+- fix: :bug: fix webgl issue with large images on small devices
+- refactor: :recycle: add additional catalog sources
+- build: :arrow_up: bump ootk
+
 #### v9.0.2
 
 >  

docs/v10.md

@@ -0,0 +1,64 @@
+# Keep Track 10 - Euclid
+
+## Software Release Documentation
+
+Version 10, codenamed "Euclid," marks a significant advancement in Keep Track's capabilities, focusing on precision, enhanced visualization, and improved user interaction. This release introduces substantial upgrades to the analysis toolkit, sensor representation, and overall system performance.
+
+## Major Features
+
+### User Interface Enhancements
+
+- Implemented a new satellite timeline plugin for comprehensive temporal analysis
+- Updated the satellite Field of View (FOV) menu, improving user interaction and data accessibility
+- Introduced a settings sub-menu to plugins, allowing for more granular control
+- Aligned keyboard shortcuts with industry standards for improved user familiarity
+
+### Data Visualization & Analysis
+
+- Added radar domes for enhanced sensor visualization
+- Introduced cone mesh and cone factory for improved 3D representations
+- Updated polar plots with SCC number and time for more detailed information
+- Improved look angles logic and added a type column for comprehensive data analysis
+
+### Performance Optimizations
+
+- Refactored sensor-fov-mesh-factory to remove duplication and deprecated methods
+- Optimized long loops through markers for faster satellite identification
+- Consolidated selectsat manager logic for improved performance
+
+### Functionality Improvements
+
+- Implemented local rotation for more precise object manipulation
+- Added searching by alternate name for flexible object identification
+- Enhanced camera keyboard controls for improved navigation
+- Updated settings and download buttons for look-angles and multi-site-looks features
+
+### Architecture & Infrastructure
+
+- Refactored and split methods in SensorFovMesh class for better maintainability
+- Implemented dynamic install location code for easier deployment
+- Added error catching for edge cases where some plugins are not loaded
+
+## Minor Features
+
+### Usability Enhancements
+
+- Updated logos and icons for a refreshed visual identity
+- Improved sensor management menus to incorporate radar domes
+
+### Data Management Improvements
+
+- Enhanced math calculations for new look angles logic
+
+## Bug Fixes
+
+- Resolved conflicts between custom sensors and normal sensors
+- Fixed cone alignment issues with satellites
+- Addressed multiple minor errors and edge cases throughout the codebase
+
+## Documentation
+
+- Updated user guides to reflect new features and improved workflows
+- Enhanced API documentation to support integration of new visualization tools
+
+This release of Keep Track represents a significant step forward in orbital analysis and visualization capabilities. As I continue to refine and expand the software, I remain committed to providing cutting-edge tools for space situational awareness and satellite tracking. Future updates will build upon these enhancements, with a focus on user-driven improvements and emerging industry needs.

docs/v5.4.md

@@ -6,37 +6,37 @@ The name "Orion Overhaul" is a blend of "Orion", a prominent constellation in th
 
 This software release offers enhanced satellite search capabilities, improved software quality through code refactoring and increased testing, as well as new visual and analysis tools.
 
-## Major Features:
+## Major Features
 
-### UI & Aesthetics:
+### UI & Aesthetics
 
 - New search filters and functionality added for satellite data.
 - Improved visuals for orbit frames with the addition of RIC and ECF plots.
 - Enhanced user feedback systems for several satellite tools.
 
-### Functionality Enhancements:
+### Functionality Enhancements
 
 - Added ability to search for stars and use the "panToStar" function.
 - Integrated satellite search on control site click.
 - Introduced the scenario-creator scaffold.
 - Enhanced breakup logic for more realistic simulations.
 - Modified breakup options for realistic interpretations.
 
-## Minor Features:
+## Minor Features
 
-### Bug Fixes:
+### Bug Fixes
 
 - Addressed various issues, including time not moving at the correct speed, ray casting on earth functionality, SOCRATES, country filters, and next pass time not updating.
 - Fixed minor issues in menus such as STF, trend analysis, and lookangles.
 - Addressed visual bugs, including missing top menu icons, image not found errors, and moon position discrepancies.
 
-### Code & Infrastructure Updates:
+### Code & Infrastructure Updates
 
 - Massive refactoring for improved code quality, including shifting from camelCase files to hyphenated naming for better git detection.
 - Addressed several SonarQube findings for better code quality.
 - Upgraded various dependencies and integrated new tools into the development pipeline, such as Cypress for testing and improved GitHub actions.
 - Transitioned several parts of the codebase to TypeScript for stronger typing and better developer experience.
 
-### Documentation:
+### Documentation
 
 - Updated changelogs, readmes, and other documentation to reflect the changes in this release and improve developer contributions.

docs/v5.md

@@ -6,16 +6,16 @@ The term "Apollo" was selected as a nod to the Apollo program by NASA, represent
 
 This software release focuses on code quality, testing, and numerous feature improvements. The central highlights include new meshes, a catalog loader, enhanced offline capabilities, and the transition to TypeScript for several modules.
 
-## Major Features:
+## Major Features
 
-### UI & Aesthetics:
+### UI & Aesthetics
 
 - Added new meshes.
 - Added political maps and upgraded surveillance fence view.
 - Added more visible error checking to the loading screen.
 - Added link to show all sensors with FOV on a satellite.
 
-### Functionality Enhancements:
+### Functionality Enhancements
 
 - Improved time sync between satCruncher, orbitCruncher, and main thread.
 - Added new catalog loader.
@@ -27,15 +27,15 @@ This software release focuses on code quality, testing, and numerous feature imp
 - Introduced autopan, zoom speed settings, and zooming on missiles.
 - Improved error detection and reporting for WebGL issues.
 
-## Minor Features:
+## Minor Features
 
 - Migrated several modules to TypeScript including camera, sun, and moon.
 - Improved offline catalog management with better handling of JSON parsing.
 - Added setting for offline editing.
 - Introduced new settings for overriding defaults.
 - Enabled the moon position to be modified with an override.
 
-### Bug Fixes:
+### Bug Fixes
 
 - Addressed a bug where WebGL would lag after highlighting certain stars.
 - Resolved issues related to full FOV not working with fence update.
@@ -44,7 +44,7 @@ This software release focuses on code quality, testing, and numerous feature imp
 - Patched a vulnerability in get_data.php.
 - Addressed a problem where 404 was always displayed.
 
-### Code & Infrastructure Updates:
+### Code & Infrastructure Updates
 
 - Extensive emphasis on testing, with many new Jest tests added and improved.
 - Consolidated and refactored various modules and code segments.
@@ -54,7 +54,7 @@ This software release focuses on code quality, testing, and numerous feature imp
 - Addressed numerous SonarQube and linting findings to improve code quality.
 - Removed old and redundant scripts and tools.
 
-### Documentation:
+### Documentation
 
 - Updated the changelog regularly to reflect changes.
 - Updated README.md.

docs/v6.md

@@ -6,15 +6,15 @@ With the emphasis on sound enhancements, transition to a more modern codebase, a
 
 In this software release, notable advancements include extensive updates on UI and functionality, a clear emphasis on performance optimization, migration from older libraries, and a concentrated effort towards debugging and enhancing reliability. The removal of jQuery across various functionalities underscores a drive towards a modern and streamlined codebase.
 
-## Major Features:
+## Major Features
 
-### UI & Aesthetics:
+### UI & Aesthetics
 
 - Introduced a new loading screen.
 - Updated the about page.
 - Optimized milky way textures for a more immersive experience.
 
-### Functionality Enhancements:
+### Functionality Enhancements
 
 - Added new sensors to enhance tracking capabilities.
 - Implemented additional TLE export options.
@@ -23,26 +23,26 @@ In this software release, notable advancements include extensive updates on UI a
 - Implemented ECI, ECF, RIC, and other analytic plots, strengthening orbital analysis tools.
 - Introduced an error reporting feature for more immediate feedback on issues.
 
-### Code & Infrastructure Updates:
+### Code & Infrastructure Updates
 
 - Migrated from satellite.js to ootk, illustrating a commitment to using updated and reliable orbital math libraries.
 - Removed jQuery from various modules, emphasizing a move to a more modern and performant codebase.
 - Added Google Cloud support, indicating a push towards scalable infrastructure.
 - Optimized code for better performance, notably color calculation speed and caching of the satrec object.
 
-### Bug Fixes:
+### Bug Fixes
 
 - Addressed several bugs related to user interface, TLE formatting, and satellite calculations.
 - Enhanced the breakup logic and options for realism.
 - Fixed issues related to ray casting on Earth.
 - Updated and fixed issues with the next pass time, lookangles menu, countries filter, and other satellite-related features.
 
-### Performance Improvements:
+### Performance Improvements
 
 - Reduced complexity in legend color code for better legibility.
 - Optimized milky way textures for better visual appeal.
 - Improved the loading times for a more responsive user experience.
 
-### Documentation:
+### Documentation
 
 - Regularly updated the changelog to reflect changes and new features.