hyperformula icon indicating copy to clipboard operation
hyperformula copied to clipboard

Improve pages specifications-and-limits and known-limitations

Open sequba opened this issue 3 years ago • 2 comments

Description

  1. Cross links between them: Something like "See also: Known limitations" or "If you are looking for the numeric limits of our software see: Specifications and limits"

  2. We might want to rename them so that the difference between their content is clearer

OR merge these 2 pages into one?

Links

https://github.com/handsontable/hyperformula/pull/933#discussion_r831250471

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

sequba avatar Mar 21 '22 15:03 sequba

As @kirszenbaum commented here:

I'd definitely change the title of the Known limitations page:

  • It looks bad (especially in the Getting started section)
  • It doesn't match the contents of the page (implementation differences and "function nuances" are not limitations)
  • It indeed sounds similar to "Specifications and limits"

My proposition is to:

  • Rename "Known limitations" to "Implementation nuances" or similar
  • Move this page from the Getting started section to the Advanced topics section
  • Change the introduction sentence to actually cover what's on the page (also, there's a typo in the 1st sentence at the moment: "This pages lists")
  • Turn the top bullet list ("Node.js versions older than...") into a separate sub-section of the page (and that section could be called "Known limitations", or "Areas for improvement", or "Areas for further development")

sequba avatar Mar 23 '22 11:03 sequba