Add guidelines for math usage in the documenation #1837
Conversation
|
That was fast :) |
There was a problem hiding this comment.
I think this is good. My only comment would be to aid the reader with a link to a "good source" to help those that might be overwhelmed with all the LaTeX documentation to know which one to use.
I do like the "use sparingly" comment. Maybe more emphasis on usage in the coding section is appropriate, while in manuals is probably not appropriate as an example?
Keep the topic short because math should be used sparingly. In particular, a full Latex reference is out of scope here; Latex is widespread enough that there are countless resources on the topic. The syntax is also way to complex to explain in a single page. Closes longturn#1719.
lmoureaux
force-pushed
the
docs/formulas
branch
from
4a08a2a
to
72e296c
Compare
Added a Wikibooks I learned a lot from, it's however more a reference than a tutorial.
Given how often we get questions about the price of unit upgrades, I think we shouldn't push back too hard on math in "normal" docs. |
Simple formulas I think are fine anywhere. It's the super complex ones that we have in the coding area that I think need to stay there. "Normal" docs should be readable by anyone with Algebra I level math knowledge (e.g. what every US high school teaches). |
|
Wording suggestion? |
|
When math formulas are used on non-technical pages (such as any one of the manuals), the reasoning should be relatively simple following elementary algebra [https://en.wikipedia.org/wiki/Elementary_algebra] |
As requested in longturn#1837.
Keep the topic short because math should be used sparingly. In particular, a full Latex reference is out of scope here; Latex is widespread enough that there are countless resources on the topic. The syntax is also way to complex to explain in a single page.
Closes #1719.