Skip to content

For Review

Bell Eapen edited this page Jan 29, 2026 · 2 revisions

For Review / Internal Notes

This page documents observations, potential issues, and legacy features identified during the v2.0 Wiki rewrite.

Legacy Shorthands

The following filter shorthands are supported but mapped to explicitly clearer versions in the documentation:

  • --filters =embedding -> embedding:text
  • --filters :temporal -> temporal:text

Recommendation: Encourage users to use the explicit embedding:text format for clarity.

Deprecated Features

  • --csv <filename>: Users should now place CSV files in the --source folder instead of using this flag. The CLI warning confirms this deprecation.

Clarifications Needed

  • --rec vs --num: These flags are overloaded.
    • In crisp --source: --num limits text files, --rec limits CSV rows.
    • In crisp analysis: --num often means "number of topics/clusters", --rec means "top N results to show".
    • In crispt search: --num is result count, --rec is similarity threshold (float).
    • Action Taken: Documentation explicitly clarifies the context for each command.

Future To-Do

  • Add screenshots to Visualization-Commands.md.
  • Create a tutorial video for the "Examples and Workflows" page.

Clone this wiki locally