davanstrien HF Staff Claude commited on
Commit
7493f69
·
1 Parent(s): 3f44783

Update CLAUDE.md with deep link sharing documentation

Browse files

- Document new deep link sharing functionality
- Explain all supported URL parameters
- Add example deep links
- Note reasoning panel state preservation
- Update reasoning trace section with URL state info

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>

Files changed (1) hide show
  1. CLAUDE.md +30 -0
CLAUDE.md CHANGED
@@ -8,6 +8,34 @@ OCR Text Explorer is a modern, standalone web application for browsing and compa
8
 
9
  ## Recent Updates
10
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ### Reasoning Trace Support (Added 2025-08-07)
12
 
13
  The application now supports displaying reasoning traces from models like NuMarkdown-8B-Thinking that include their analysis process in the output:
@@ -19,6 +47,7 @@ The application now supports displaying reasoning traces from models like NuMark
19
  - Reasoning statistics (word count, percentage of total output)
20
  - Support for formatted reasoning steps with numbered analysis points
21
  - "Reasoning Trace" badge indicator in the statistics panel
 
22
 
23
  **Implementation Details:**
24
  - New `reasoning-parser.js` module handles detection and parsing of reasoning traces
@@ -26,6 +55,7 @@ The application now supports displaying reasoning traces from models like NuMark
26
  - Formats numbered steps from reasoning content for structured display
27
  - Caches parsed reasoning to avoid reprocessing
28
  - Exports include optional reasoning trace content
 
29
 
30
  **Supported Datasets:**
31
  - `davanstrien/india-medical-ocr-test` - Medical documents processed with NuMarkdown-8B-Thinking
 
8
 
9
  ## Recent Updates
10
 
11
+ ### Deep Link Sharing (Added 2025-08-07)
12
+
13
+ The application now supports deep linking with full state preservation for easy sharing and collaboration:
14
+
15
+ **Features:**
16
+ - Complete URL state management for all view settings
17
+ - Copy Link button for one-click sharing
18
+ - Automatic restoration of view state from URL parameters
19
+ - Success notification when link is copied
20
+
21
+ **URL Parameters Supported:**
22
+ - `dataset` - HuggingFace dataset ID
23
+ - `index` - Sample index (0-based)
24
+ - `view` - View mode (comparison, diff, improved)
25
+ - `diff` - Diff algorithm (char, word, line, markdown)
26
+ - `markdown` - Markdown rendering state (true/false)
27
+ - `reasoning` - Reasoning panel expansion state (true/false, only for samples with reasoning traces)
28
+
29
+ **Implementation Details:**
30
+ - URL updates automatically as users navigate and change settings
31
+ - Prevents double-loading when URL contains specific index
32
+ - Fallback clipboard API support for older browsers
33
+ - Reasoning state only included in URL when reasoning trace is present
34
+
35
+ **Example Deep Links:**
36
+ - Basic: `/?dataset=davanstrien/exams-ocr&index=5`
37
+ - Full state: `/?dataset=davanstrien/india-medical-ocr-test&index=0&view=improved&diff=word&markdown=true&reasoning=true`
38
+
39
  ### Reasoning Trace Support (Added 2025-08-07)
40
 
41
  The application now supports displaying reasoning traces from models like NuMarkdown-8B-Thinking that include their analysis process in the output:
 
47
  - Reasoning statistics (word count, percentage of total output)
48
  - Support for formatted reasoning steps with numbered analysis points
49
  - "Reasoning Trace" badge indicator in the statistics panel
50
+ - Deep link support preserves reasoning panel state
51
 
52
  **Implementation Details:**
53
  - New `reasoning-parser.js` module handles detection and parsing of reasoning traces
 
55
  - Formats numbered steps from reasoning content for structured display
56
  - Caches parsed reasoning to avoid reprocessing
57
  - Exports include optional reasoning trace content
58
+ - Reasoning panel state included in shareable URLs
59
 
60
  **Supported Datasets:**
61
  - `davanstrien/india-medical-ocr-test` - Medical documents processed with NuMarkdown-8B-Thinking