Skip to content

docs(eldritch): add standard library summaries and support UI tooltips#1959

Merged
KCarretto merged 3 commits intomainfrom
feature/docs-lib-tooltips-14705079632972166039
Feb 27, 2026
Merged

docs(eldritch): add standard library summaries and support UI tooltips#1959
KCarretto merged 3 commits intomainfrom
feature/docs-lib-tooltips-14705079632972166039

Conversation

@KCarretto
Copy link
Copy Markdown
Collaborator

Added documentation for standard libraries in the Eldritch documentation and wired them up to the Shell terminal's documentation tooltip logic by enhancing the internal documentation parser. Fixed a related bug where top-level object token highlighting inadvertently matched over method highlighting in the terminal UI.


PR created automatically by Jules for task 14705079632972166039 started by @KCarretto

This commit updates the Eldritch user guide to include short, 2-3 sentence summaries of each standard library module (Agent, File, HTTP, etc.). The web frontend's doc generation script (`generate-docs.js`) has been modified to parse these `## Library` headers in addition to the standard function signatures.

On the frontend, this allows library names (e.g., `agent`, `sys`) to have dedicated documentation objects. The terminal syntax highlighting script in `shellUtils.ts` has been refactored to sort parsed docs keys by length descending, which correctly separates the syntax highlighting for `agent` and `agent.get_config`, allowing both tooltips to trigger flawlessly without masking each other. All tests passed.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 27, 2026

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
2727    ±0 2727    ±0 0    ±0 0    ±0 0    ±0 0    ±0 1ms    ±0

Previous Results

Build 🏗️ Result 🧪 Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
#1421 2727 2727 0 0 0 0 44.2s

Insights

Average Tests per Run Total Flaky Tests Total Failed Slowest Test (p95)
2727 0 0 5.6s

Slowest Tests

Test 📝 Results 📊 Duration (avg) ⏱️ Duration (p95) ⏱️
TestDockerExecutor_Build_ContextCancellation 1 5.6s 5.6s
eldritch-libsys: std::dll_inject_impl::tests::test_dll_inject_simple 1 5.1s 5.1s
TestInteractiveShell 1 5.1s 5.1s
TestOtherStreamOutput 1 5.0s 5.0s
imix::bin/imix: install::tests::test_install_execution 3 1.6s 4.7s
imix::bin/imix: install::tests::test_install_execution 3 1.6s 4.7s
imix::bin/imix: install::tests::test_install_execution 3 1.6s 4.7s
imix::bin/imix: tests::task_tests::test_task_streaming_output 3 3.0s 3.0s
imix::bin/imix: tests::task_tests::test_task_streaming_output 3 3.0s 3.0s
imix::bin/imix: tests::task_tests::test_task_streaming_output 3 3.0s 3.0s

🎉 No failed tests in this run. | 🍂 No flaky tests in this run.

Github Test Reporter by CTRF 💚

🔄 This comment has been updated

// Add the last function or library
if (inLibrarySection && currentLibrary) {
docs[currentLibrary] = {
signature: `import ${currentLibrary}`,
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't support an import statement, so change this to just signature: ${currentLibrary}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Changed the signature to simply use the library name instead of import ....

google-labs-jules bot and others added 2 commits February 27, 2026 21:38
…ment

Updates `generate-docs.js` to assign `signature: currentLibrary` rather than `import ${currentLibrary}`.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
@KCarretto KCarretto marked this pull request as ready for review February 27, 2026 21:59
@KCarretto KCarretto enabled auto-merge February 27, 2026 21:59
@KCarretto KCarretto disabled auto-merge February 27, 2026 21:59
@KCarretto KCarretto merged commit 9bb8a4d into main Feb 27, 2026
8 checks passed
@KCarretto KCarretto deleted the feature/docs-lib-tooltips-14705079632972166039 branch February 27, 2026 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant