... | ... | @@ -20,6 +20,17 @@ When writing new sections, particularly for models or visualizations, ensure tha |
|
|
|
|
|
3. **Examples (How to Use It & Good and Bad Practice)**: Provide at least one example (with code or visualization) demonstrating the correct usage of the method or visualization. Include both good and bad practice examples where applicable. Highlight what works well and why, and explain common pitfalls or mistakes to avoid. Be mindful of tone when discussing limitations—frame these as learning opportunities and avoid harsh criticism of specific studies or scientists.
|
|
|
|
|
|
## Mathematical Formulas
|
|
|
|
|
|
When adding mathematical formulas to your documentation, please use one of the following methods:
|
|
|
|
|
|
1. **Plain Text**: For simple formulas, write them directly in plain text using basic symbols.
|
|
|
|
|
|
2. **Images**: For more complex formulas, use external tools like [Codecogs](https://www.codecogs.com/latex/eqneditor.php) to generate LaTeX equations as images (PNG/SVG) and embed them in the document.
|
|
|
|
|
|
Be sure to upload images of formulas to keep your documentation clear and consistent across all platforms, especially if LaTeX support is not available.
|
|
|
|
|
|
|
|
|
## Visualization Guidelines
|
|
|
|
|
|
To ensure uniformity, all visualizations should use the following font and color scheme:
|
... | ... | |