Skip to content

Remove .qmd files from the .gitignore and regenerate Python API source#439

Merged
nrichers merged 1 commit intomainfrom
nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n
Oct 16, 2025
Merged

Remove .qmd files from the .gitignore and regenerate Python API source#439
nrichers merged 1 commit intomainfrom
nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 16, 2025

Pull Request Description

What and why?

After a wild goose chase of trying to figure out why we were missing newer Python API files in our output, I figured it out: we had added the *.qmd files to the .ignore during a recent PR review, because we expect a GitHub workflow to generate and commit the files.

After doing a bit of research, GitHub workflows also respect the .gitignore and so this addition not only affects what gets committed locally but would also break our workflow, if it wasn't broken already.

That's it, this is the sum total of our problems. Removed 1 line, regenerated the files, and all is well. Took some serious head-scratching until the penny dropped, though, as I expected there to be a complicated problem and started digging deep. The final clue was this differently colored file in Cursor:

Capto_ 2025-10-16_10-28-14_am2

Relates to:

How to test

Check the preview: LIVE PREVIEW

Before

Preparing to preview

Watching files for changes
Browse at http://localhost:4444/
Listening on http://127.0.0.1:4444/
GET: /
WARN: Unable to resolve link target: validmind/validmind/datasets/llm.qmd
WARN: Unable to resolve link target: validmind/validmind/datasets/llm/rag.qmd
WARN: Unable to resolve link target: validmind/validmind/datasets/llm/rag/rfp.qmd
WARN: Unable to resolve link target: validmind/validmind/scorer.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/plots.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/plots/BoxPlot.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/plots/CorrelationHeatmap.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/plots/HistogramPlot.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/plots/ViolinPlot.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/stats.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/stats/CorrelationAnalysis.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/stats/DescriptiveStats.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/stats/NormalityTests.qmd
WARN: Unable to resolve link target: validmind/validmind/tests/stats/OutlierDetection.qmd
GET: /validmind/validmind.html

After

Preparing to preview

Watching files for changes
Browse at http://localhost:4444/
Listening on http://127.0.0.1:4444/
GET: /
GET: /validmind/validmind.html

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added bug Something isn't working internal Not to be externalized in the release notes labels Oct 16, 2025
@CLAassistant
Copy link

CLAassistant commented Oct 16, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@nrichers nrichers force-pushed the nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n branch 2 times, most recently from a5923a6 to 9d64b6d Compare October 16, 2025 19:22
@github-actions
Copy link
Contributor

PR Summary

This PR introduces a number of documentation enhancements that detail new functionality in the project. The major changes include:

  • Removal of the *.qmd entry from .gitignore, which may allow Quarto markdown files to be tracked.
  • Updates to version references in the sidebar and main documentation pages to reflect the new version 2.10.0.
  • Addition of extensive new documentation pages:
    • A new dataset integration page for LLMAgentDataset that describes a class to integrate DeepEval test cases, goldens, and evaluation datasets. This includes new methods for adding test cases/goldens, converting them, evaluating, and converting between different representations.
    • A new set of documentation files under the llm/rag directory, which includes a module page and a documentation page for functions like load_data and preprocess for rag datasets.
    • New documentation for custom scorer functionality. The added scorer page outlines a decorator-based approach for registering scoring functions, listing, describing, and running scorers.
    • A series of test documentation pages for visualization (BoxPlot, CorrelationHeatmap, HistogramPlot, ViolinPlot) that detail their purpose, mechanism, risks, strengths, and limitations.
    • New statistical analysis documentation pages for correlation analysis, descriptive statistics, normality tests, and outlier detection with comprehensive descriptions of their test mechanisms.

These changes enhance the clarity and guidance provided in the docs and introduce new content that reflects the extended functionality of the software.

Test Suggestions

  • Render the new documentation locally to verify that all sections (datasets, scorers, plots, and stats) display correctly.
  • Check that version references are consistent across all modified documentation pages.
  • Validate that new links between documentation pages (e.g., from the sidebar to the new pages) work as expected.
  • Confirm that the removal of '*.qmd' from .gitignore does not unintentionally track temporary files in the repository.

@nrichers nrichers requested a review from validbeck October 16, 2025 19:26
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

🥹

@nrichers nrichers merged commit 03d6dbb into main Oct 16, 2025
22 of 24 checks passed
@nrichers nrichers deleted the nrichers/sc-12759/fix-missing-pyton-api-content-in-v2-9-n branch October 16, 2025 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants