Skip to content

Enhance documentation of "Supported Models" #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 29, 2023
Merged

Conversation

p-m-s-f
Copy link
Contributor

@p-m-s-f p-m-s-f commented Jul 13, 2023

Responding to this story.

This is a basic, first draft rewrite of the "Supported Models" docs page. Now includes a basic definition for supported models, as well as references to the docs pages on implementing custom tests and integrating external providers.

image

I'm expecting to rewrite the definition for supported models and expand the table in the very-near future. I've also noticed some odd behaviour brought on by the large width of the table. The "On this page" widget overlaps with the table as you scroll down the page, and the footer cuts off if you scroll to the right.

image
image

External Release Notes

The list of supported models has been updated.

@p-m-s-f p-m-s-f requested a review from nrichers July 13, 2023 23:28
@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers
Copy link
Collaborator

@p-m-s-f fixed some merge conflicts for you in this PR, FYI.

@nrichers nrichers added the documentation Improvements or additions to documentation label Jul 18, 2023
@github-actions
Copy link
Contributor

Pull requests must include a description in the release notes section.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

@p-m-s-f can you get Mehdi or Andres to review and approve, then we can merge this PR and close the story.

EDIT: Please and thank you! 🎉

@nrichers
Copy link
Collaborator

@p-m-s-f I think there is one unresolved comment — could you address, please so I can approve? Thank you!

@p-m-s-f p-m-s-f closed this Jul 27, 2023
@p-m-s-f p-m-s-f reopened this Jul 27, 2023
@p-m-s-f
Copy link
Contributor Author

p-m-s-f commented Jul 27, 2023

@nrichers ready for review

Co-authored-by: Parris Mook-Sang-Forbes <parris@validmind.ai>
@nrichers nrichers force-pushed the enhance-supported-models branch from 4137b50 to 45f6622 Compare July 29, 2023 00:45
@nrichers nrichers added the internal Not to be externalized in the release notes label Jul 29, 2023
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

There were some artefacts from the release notes script work in this branch, so I reset the branch and then re-added the supported models changes (with co-authored by to credit Parris). LGTM now.

@nrichers nrichers merged commit 3c28352 into main Jul 29, 2023
@nrichers nrichers deleted the enhance-supported-models branch September 28, 2023 21:59
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.

2 participants