Skip to main content

Smarter Documentation Search

Matouš Čmelík
FW Developer

Searching the documentation just got a lot more accurate. When you search for a parameter, state variable, or shell command, the first result now takes you straight to the page where it is actually explained — not to a random page that merely mentions the word.

What changed​

Reference pages — the places where parameters, variables and commands are documented — are now prioritized in the search ranking. On top of that, every important term has been assigned to its canonical documentation page, so exact-name searches land exactly where you expect.

Try it out​

Search for any of these and the first hit should be the correct reference page:

  • iref → the reference parameters page, where the stator reference current is described
  • run → the driver shell commands page, with the run [command] [mode] ... syntax
  • identrun → the motor identification commands
  • prest → the motor sensor selection page
  • ubmin → the battery voltage limiter
  • stat → the driver protection state word
  • csc → the Control Signal Conditioner module

If a term also has a related FAQ or tutorial, it will show up right below the reference page.

Public site only​

Why only docs.silixcon.com?

This improvement applies only to the public site docs.silixcon.com, which uses Algolia as its search engine.

All private instances (*.private.silixcon.com) intentionally use a different, fully local search engine that does not send any information to third-party servers. Keeping your searches on private instances completely private is the reason they are not affected by this change.