search

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

Doc changes for v4.4 #753

Closed grumpyinca closed 1 year ago

grumpyinca commented 1 year ago

This issue provides a branch to contain documentation improvements for version 4.4.

Documentation changes for version 4.3 were mostly alert related and handled in the various alert related issue / branches.

Notes:

Changes to /docs/About/messageOfTheDay.md will be published to GitHub Pages (https://thegrumpys.github.io/odop/...) momentarily after being pushed to master.

Changes to /client/docs/... will not be published to Heroku (https://odop.herokuapp.com/docs/...) until the formal release (git push heroku master).

grumpyinca commented 1 year ago

Fix typo "mathermatical " in three places. Find a way to run all the docs through a spell checker.

grumpyinca commented 1 year ago

Added link: RoyMech - Helical Spring Design to references.md.

Created issue #795 in next release to approach RoyMech for a corresponding exchange link.

grumpyinca commented 1 year ago

Multiple changes including alert text updates, a major re-work of the Setting Values topic and selecting a standard wire size in Calculator View. The description.md entries for each of the spring design types got converted to MarkDown tables. Minor update to the GitHub README.md file.

grumpyinca commented 1 year ago

Merged to master, pushed to remote. Closing.