Skip to content

Make SQL Race API Example codes pretty again - #60

Merged
federicadonald merged 7 commits into
masterfrom
beautify-sqlrace-examples
Jul 2, 2026
Merged

federicadonald merged 7 commits into
masterfrom
beautify-sqlrace-examples

Conversation

@federicadonald

@federicadonald federicadonald commented Jun 10, 2026 •

Copy link
Copy Markdown
Contributor

Beautifying the example code and adding some extra MATLAB and Python examples in a clear and orderly fashion (goodbye HelloData)

Old: Scattered individual projects, unclear starting point.
New: Three-tier structure guiding users from snippets → projects → notebooks.

snippets/       Single-file, copy-paste examples
projects/       Complete, buildable applications  
notebooks/      Interactive Jupyter notebooks
docs/           Guides, troubleshooting, industry mapping
tests/          Automated testing & validation

Why It's Better
✨ Clear learning path — README's "I want to..." index maps 30+ use cases to examples
📦 Multi-language — C#, Python, MATLAB at all tiers
🔧 Production-ready — Shared Core library, CI/CD workflows, contributing guidelines
🎯 Better discovery — Concepts guide, troubleshooting, connection-string reference
✅ Validated — All snippets compile, all notebooks validate in CI

Changes
Removed: 15+ scattered projects, monolithic solution files
Added: 51 C# snippets, 11 Python snippets, 4 Jupyter notebooks, 5 documentation guides
Maintained: All existing functionality and examples (reorganized)

@federicadonald
federicadonald marked this pull request as ready for review June 10, 2026 12:17
@davidtopham

Copy link
Copy Markdown

This documentation is loads better! I can try helping review the MATLAB examples if you need.

CarlesAB
CarlesAB previously approved these changes Jun 12, 2026

@CarlesAB CarlesAB left a comment

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.

Happy to proceed with the new Examples layout. I also have some MATLAB API Examples we could add.

Expand the MATLAB snippet tier to mirror the C# categories:

- getting-started: create_session_write_data, list_parameters, load_session_from_database

- data-access: read_samples_between, subsampled_read, reverse_iteration, data_status_filtering, plot_parameters

- session-management: session_metadata, marker_management, lap_segment_management, event_extraction

- configuration: introspect_session_config, parameter_unit_resolution

- functions: read_function_output

- live-data: poll_live_samples, server_listener

Align query_sessions with the bundled scenario data and update the MATLAB README, COOKBOOK, and top-level README indexes.
Comment thread nuget.config Outdated
Comment thread tools/SnippetRunner/Program.cs.bak Outdated
@federicadonald
federicadonald merged commit 4469495 into master Jul 2, 2026
2 checks passed
@federicadonald
federicadonald deleted the beautify-sqlrace-examples branch July 2, 2026 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants