SSWConsulting / SSWConsulting/SSW.Rules

Math representation in Rules

Open
#647 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

Cc: @bradystroud @taineriley1

Hi guys,

Would be great if there was an easy way to insert math equations into rules for any accounting formulas etc. For example the below formula doesn't look good on the rule https://www.ssw.com.au/rules/return-on-investment, and should be represented as a Business Value / Effort.

image
Figure: Not ideal maths representation

Options:
I'm not exactly sure how this could be done, but here are some investigation options:

  1. Gatsby markdown plugin: https://www.gatsbyjs.com/plugins/gatsby-remark-mathjax/
  2. Some embedding tools, which are more likely to break, e.g. www.sciweavers.org : equation

Ideally we could also represent this using Netlify when editing rules, and there is an open GitHub issue about this: https://github.com/netlify/netlify-cms/issues/1279

Thanks
Jack

AB#63532

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how Rules content is authored and rendered, then evaluate the Gatsby remark-mathjax option and the linked Netlify CMS issue. Define the supported equation syntax and verify that formulas display correctly in published rules and, if feasible, while editing.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, nextjs, typescript
Domain
content, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.