Skip to content

Enhance Model Display UI in ReadTheDocs#632

Merged
darrylong merged 5 commits intoPreferredAI:masterfrom
darrylong:fix-model-docs-display
Jul 18, 2024
Merged

Enhance Model Display UI in ReadTheDocs#632
darrylong merged 5 commits intoPreferredAI:masterfrom
darrylong:fix-model-docs-display

Conversation

@darrylong
Copy link
Copy Markdown
Member

Description

Following up from #624, this PR splits model table display into a separate page, with a dedicated section on documentation.

The sections will now consist of the following:
image

Table Filters:

  • Reorganized filters interface where users could filter by text or type.
    image

  • Clear filter button is disabled when no filters are applied

  • When a filter is applied, label indicates filter applied and filters could be cleared with the 'Clear Filters' button
    image

Related Issues

Checklist:

  • I have added tests.
  • I have updated the documentation accordingly.
  • I have updated README.md (if you are adding a new model).
  • I have updated examples/README.md (if you are adding a new example).
  • I have updated datasets/README.md (if you are adding a new dataset).

@darrylong darrylong self-assigned this Jul 1, 2024
@darrylong darrylong requested a review from qtuantruong July 1, 2024 07:02
@darrylong darrylong merged commit 5c8cd20 into PreferredAI:master Jul 18, 2024
@darrylong darrylong deleted the fix-model-docs-display branch July 18, 2024 04:44
@darrylong darrylong added the docs Documentation (Readme, readthedocs) related label Jul 22, 2024
qtuantruong pushed a commit to qtuantruong/cornac that referenced this pull request Oct 25, 2025
* Add dark theme to readthedocs model table

* Restructure models table into separate section

* Add filter label and changed clear filters button behavior

* Add color highlighting for selected filter
qtuantruong pushed a commit to qtuantruong/cornac that referenced this pull request Oct 25, 2025
* Add dark theme to readthedocs model table

* Restructure models table into separate section

* Add filter label and changed clear filters button behavior

* Add color highlighting for selected filter
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation (Readme, readthedocs) related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants