Skip to content

Rename and restructure Supported Models page#1163

Open
nrichers wants to merge 2 commits intomainfrom
sc-5014/supported-model-frameworks
Open

Rename and restructure Supported Models page#1163
nrichers wants to merge 2 commits intomainfrom
sc-5014/supported-model-frameworks

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Feb 10, 2026

Pull Request Description

What and why?

Renames "Supported Models" to "Supported Model Frameworks" and restructures content:

  • Framework support with wrapper classes and installation commands
  • Test input requirements (when predict() vs predict_proba() is needed)
  • How to use precomputed predictions without a model object
  • Custom model wrappers (FunctionModel, PipelineModel)
  • GenAI/LLM and RAG evaluation support
  • Python and dependency compatibility

Adds alias to preserve existing links to supported-models.html.

Addresses sc-5014.

How to test

  1. Check the deploy preview link below
  2. Verify the new page renders at /developer/supported-model-frameworks.html
  3. Verify the alias redirects from /developer/supported-models.html
  4. Review Mermaid diagrams (class hierarchy, test input flow) render correctly

What needs special review?

  • Accuracy of framework requirements table
  • Mermaid diagram rendering

Dependencies, breaking changes, and deployment notes

  • Alias ensures no breaking change for existing links

Release notes

Restructured the "Supported Models" documentation page as "Supported Model Frameworks" with clearer guidance on test requirements, framework wrappers, and GenAI/RAG support. Learn more

Checklist

  • What and why
  • How to test
  • PR linked to Shortcut
  • Tested locally

@nrichers nrichers added the documentation Improvements or additions to documentation label Feb 10, 2026
@nrichers nrichers force-pushed the sc-5014/supported-model-frameworks branch from 35cd69b to 8478562 Compare February 10, 2026 05:24
@claude
Copy link

claude bot commented Feb 10, 2026

Code Review

Found 1 issue that needs to be addressed:

Issue: Broken sidebar navigation link

File: site/developer/_sidebar.yaml at line 13

Problem: The sidebar file still references developer/supported-models.qmd, which is deleted by this PR. The reference needs to be updated to developer/supported-model-frameworks.qmd to match the new filename.

Impact: Without this change, the Quarto build will fail or produce a broken navigation entry in the sidebar.

Current code (line 13):

        - developer/supported-models.qmd

Should be:

        - developer/supported-model-frameworks.qmd

References:


Note: All other internal references (in overview-model-documentation.qmd and faq-integrations.qmd) were correctly updated. The aliases in the new file properly preserve old URL paths for backwards compatibility.

- Rename supported-models.qmd to supported-model-frameworks.qmd
- Add alias for old URL to preserve links
- Restructure content into clearer sections:
  - Framework support with wrapper classes and install commands
  - Test input requirements (predict vs predict_proba)
  - Custom model wrappers (FunctionModel, PipelineModel)
  - GenAI and LLM support
  - RAG evaluation with RAGAS
  - Python and dependency compatibility
- Add Mermaid diagrams for class hierarchy and test input flow
- Update references in faq-integrations.qmd and overview-model-documentation.qmd
@nrichers nrichers force-pushed the sc-5014/supported-model-frameworks branch from 8478562 to 2db869e Compare February 10, 2026 05:25
@nrichers nrichers added the internal Not to be externalized in the release notes label Feb 10, 2026
@github-actions
Copy link
Contributor

PR Summary

This PR modifies documentation to update references from an old supported models page to a new, more comprehensive Supported Model Frameworks page. Specifically, the changes include:

  • Updating link references in the About, Developer sidebar, and FAQ sections to point to /developer/supported-model-frameworks.qmd instead of the old /developer/supported-models.qmd.
  • Introducing a new documentation file (supported-model-frameworks.qmd) that provides detailed information about the supported model frameworks, including framework support, installation instructions, usage examples, diagrams (mermaid charts), and testing guidelines.
  • Removing the old supported models documentation file to streamline and avoid duplication of content.

These changes improve the clarity and relevance of the documentation, aligning the content with current terminology and the expanded scope of supported frameworks.

Test Suggestions

  • Verify that all updated links (sidebar, FAQ, and in-page references) correctly navigate to the new supported model frameworks documentation.
  • Render the new supported-model-frameworks.qmd page to ensure that all diagrams, code samples, and tables display correctly.
  • Conduct a regression test for documentation navigation to confirm that the removal of the older file does not break site navigation.
  • Check that all markdown and mermaid diagram syntax in the new page works as expected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant