Tabular Editor Documentation Search

Efficient local search of Tabular Editor documentation using the cloned TabularEditorDocs repository.

Why Local Search

The Tabular Editor docs site (docs.tabulareditor.com) has URL redirect issues that cause 404 errors for many AI agents. Local search via ripgrep is:

• •Faster - No HTTP latency
• •Reliable - No 404s or JS redirect failures
• •Complete - Full access to all documentation
• •Searchable - Grep across entire doc corpus

Setup

1. Clone the Repository

Clone the TabularEditorDocs repository to a local directory:

Windows (PowerShell):

git clone https://github.com/TabularEditor/TabularEditorDocs.git C:\Git\TabularEditorDocs

macOS/Linux:

git clone https://github.com/TabularEditor/TabularEditorDocs.git ~/Git/TabularEditorDocs

2. Configure Path (Optional)

Set environment variable TABULAR_EDITOR_DOCS to your clone location:

Windows (PowerShell):

$env:TABULAR_EDITOR_DOCS = "C:\Git\TabularEditorDocs"
# Or set permanently via System Properties > Environment Variables

macOS/Linux:

export TABULAR_EDITOR_DOCS=~/Git/TabularEditorDocs

Directory Structure

Search Commands

Replace <DOCS_PATH> with your clone location (e.g., C:\Git\TabularEditorDocs on Windows or ~/Git/TabularEditorDocs on macOS/Linux).

Basic Topic Search

Cross-platform (ripgrep):

rg -i "topic" <DOCS_PATH>/content --type md

Search with Context

rg -i "topic" <DOCS_PATH>/content --type md -C 3

Search Specific Section

rg -i "topic" <DOCS_PATH>/content/features --type md

Find Files by Name

Windows (PowerShell):

Get-ChildItem -Path <DOCS_PATH>\content -Filter "*bpa*" -Recurse -File

macOS/Linux:

find <DOCS_PATH>/content -name "*bpa*" -type f

Common Search Targets

URL Resolution

The docs site underwent a major reorganization. Use references/url-redirects.md for mapping old URLs to new paths when users provide outdated links.

Quick URL Patterns

Workflow

When User Asks About TE Feature

1. •Search local docs: rg -i "feature-name" <DOCS_PATH>/content --type md -l
2. •Read relevant file(s)
3. •Synthesize answer from documentation

When User Provides Broken URL

1. •Extract the path from URL (e.g., /common/using-bpa.html)
2. •Check references/url-redirects.md for new path
3. •Find corresponding local file in content/
4. •Read and provide content

When User Needs Comprehensive Info

1. •List files in relevant directory
2. •Read multiple related files
3. •Combine information in response

Knowledge Base Articles

The content/kb/ directory contains detailed articles on specific topics:

• •bpa-*.md - BPA rule explanations and fixes
• •DI*.md, DR*.md, RW*.md - Error code documentation

Search KB for specific issues:

rg -i "error description" <DOCS_PATH>/content/kb --type md

Updating Local Docs

Keep your local clone current:

Windows (PowerShell):

Push-Location <DOCS_PATH>
git pull origin main
Pop-Location

macOS/Linux:

cd <DOCS_PATH> && git pull origin main

Key Documentation Files

For common topics, read these files directly:

Additional Resources

Reference Files

• •references/url-redirects.md - Complete URL redirect mapping from old to new paths
• •references/doc-structure.md - Detailed documentation structure and file purposes