hyperformula icon indicating copy to clipboard operation
hyperformula copied to clipboard

More links from the API reference to the guides

Open warpech opened this issue 3 years ago • 1 comments

Some options have a very short explanation in the API reference and it is not clear what they apply to. On the other hand, they are nicely explained in the Guides. I think that a link from API reference to the Guide is missing for these options.

Ideally, all entries in the API reference should have a link to the relevant guide.

Example: https://handsontable.github.io/hyperformula/api/interfaces/configparams.html#ignorepunctuation is missing a link to https://handsontable.github.io/hyperformula/guide/types-of-operators.html#order-operations-comparisons

Type of issue

  • [ ] Missing documentation
  • [ ] Error in the documentation
  • [ ] Request for a demo
  • [ ] Request for a tutorial, guide etc.
  • [x] Other issues, suggestions or ideas

warpech avatar Mar 24 '22 09:03 warpech

Another example: The API reference efor https://handsontable.github.io/hyperformula/api/interfaces/configparams.html#chooseaddressmappingpolicy should be linked to the Guide https://handsontable.github.io/hyperformula/guide/performance.html#address-mapping-strategies, because the API reference does not explain the point of using the configuration option chooseAddressMappingPolicy.

warpech avatar Jun 24 '22 10:06 warpech