thegrumpys / odop

Open Design Optimization Platform (ODOP) - Coil spring design app; mechanical springs; compression spring, extension spring, torsion spring
https://www.springdesignsoftware.org
MIT License
4 stars 5 forks source link

Enhance doc and alert text (based on v4.6dev) #895

Closed grumpyinca closed 1 month ago

grumpyinca commented 9 months ago

While based on a master in the 4.6dev timeframe, the doc changes contemplated at the time that this issue is opened are not strongly tied to the 4.6 release (or any specific release). Thus, the changes created in this branch may ultimately become part of a different release.

/docs/Help/DesignTypes/Spring/{type}/alerts.md expand discussion of:

/docs/Help/alerts.md

grumpyinca commented 8 months ago

Create a new "Guidelines" entry under docs/design. Use it to centralize:

grumpyinca commented 8 months ago

Add a statement to the GitHub README along the lines of:

If you are developing software that utilizes any of this material, please contact us. We would like to work with you. Specifically, we may be able to integrate pull requests such that your work can more easily take advantage of our future enhancements.

grumpyinca commented 1 month ago

An August 15, 2024 review has confirmed that this branch contains changes that have not yet been merged to master.

grumpyinca commented 1 month ago

Merged to master. Closing.