Update all the docs

[tobyhede]

U̶p̶d̶a̶t̶e̶ Rewrite all the docs

I've completed a thorough and intensive documentation review of the Encrypt Query Language (EQL) project.

Major Changes

1. Created New Documentation

• docs/reference/eql-functions.md (498 lines) - Comprehensive API reference for all 40+ EQL functions, organized by category with both operator and function equivalents
• docs/reference/database-indexes.md (391 lines) - Complete guide to PostgreSQL B-tree index creation, usage requirements, troubleshooting, and best practices based on operator_class_test.sql

2. Completely Rewrote Documentation

• docs/reference/json-support.md - Reduced from 887 to 297 lines, removed all references to non-existent functions (ste_vec_value, ste_vec_term, ste_vec_terms), documented actual API (jsonb_path_query,
  jsonb_array_elements, operators)

3. Fixed Documentation

• docs/tutorials/proxy-configuration.md - Corrected to show direct operator usage instead of wrapped function calls
• docs/reference/index-config.md - Fixed all function names from cs_* to eql_v2.*, added missing cast types (real, double)
• docs/README.md - Fixed broken links, added references to new documentation files
• README.md - Enhanced with step-by-step getting started, troubleshooting section
• DEVELOPMENT.md - Updated with merged content from src/README.md

Cross-References Established

All documentation files now have proper cross-references:

• database-indexes.md ↔ eql-functions.md ↔ json-support.md ↔ proxy-configuration.md ↔ index-config.md
• All links verified to exist and point to correct locations

Key Corrections Made

1. Operators work directly on encrypted columns - no function wrappers needed in normal environments
2. Function versions exist only for Supabase or operator-restricted environments
3. PostgreSQL indexes require the eql_v2.encrypted_operator_class operator class
4. Index terms must exist in data BEFORE creating PostgreSQL indexes
5. Proper type casting to eql_v2_encrypted is required for index usage

Verification Process

All documentation has been verified against:

• Actual test files (operator_class_test.sql, functions_test.sql, etc.)
• Source code implementations (src/config/functions.sql, src/jsonb/functions.sql, etc.)
• Cross-referenced between docs to ensure consistency

[calvinbrewer]

What happens when we are using Protect? Do those functions do something special?

[tobyhede]

Good catch.
The add_search_config function is just how the config is added when using EQL/Proxy.

For protect.js, assuming the config is setup and EQL is installed, just needs to be:

CREATE INDEX ON users (encrypted_email eql_v2.encrypted_operator_class);

Maybe these docs should mention the config in more general terms, and explicitly reference other config options?

Definitely another step here to take this reference documentation and turn into reference for protect and support content for website.

[freshtonic]

Given the prior state of the docs this is a massive improvement.

Added non-blocker comment about improving code examples.

[freshtonic]

Not a blocker but more of a seed to think about how we can improve this later. The raw payload is very noisy and grabs attention when what we really care about here is drawing attention to the <.

Same for the other examples.