Skip to content

Commit

Permalink
Formula evaluator missing in docs sidebar #162
Browse files Browse the repository at this point in the history
resolves #162
  • Loading branch information
paustint committed Mar 1, 2023
1 parent 0fcf2f5 commit 03858bc
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 6 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 16 additions & 5 deletions apps/docs/docs/deploy/formula-evaluator.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,25 @@ Some formula functions are not yet supported and some complex formulas may not w
1. Choose which object you would like to work on
2. Choose how numbers should be treated for fields with no value
3. Choose if you want to write a formula from scratch or if you have an existing field you want to start from
1. If you choose an existing field, the formula editor will be populated with the existing formula
4. Write your formula
5. Provide a record id
5. Search and choose a record
6. Click "Test Formula"

:::tip
### Editor

Make sure to press `ctrl` + `space` while editing to show a list of options
The advanced editor includes syntax highlighting, code completion and the ability to format your formula.

:::
<img src={require('./formula-evaluator-editor.png').default} alt="Formula editor" />

### Intellisense

Use the shortcut `ctrl` + `space` while editing to show a list of available formulas and object and field completions.

<img src={require('./formula-evaluator-intellisense.png').default} alt="Formula intellisense" />

### Results

Your results will be evaluated based on the selected Object and record.

You will see the results of your formula on the page.
<img src={require('./formula-evaluator-results.png').default} alt="Formula evaluation results" />
2 changes: 1 addition & 1 deletion apps/docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ module.exports = {
{
type: 'category',
label: 'Deploy Metadata',
items: ['deploy/deploy-metadata', 'deploy/deploy-fields'],
items: ['deploy/deploy-metadata', 'deploy/deploy-fields', 'deploy/formula-evaluator'],
},
{
type: 'category',
Expand Down

0 comments on commit 03858bc

Please sign in to comment.