Skip to content
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

Docs and cleanup #492

Merged
merged 15 commits into from
Jan 26, 2024
Merged

Docs and cleanup #492

merged 15 commits into from
Jan 26, 2024

Conversation

AnesBenmerzoug
Copy link
Collaborator

@AnesBenmerzoug AnesBenmerzoug commented Jan 24, 2024

Description

This PR closes address parts of #462 and #489.

Changes

  • Replace neoteroi plugin cards with mkdocs-material cards in the documentation home page.
  • Make cards grow and change color just like in the transferlab website.
  • Change title of first-steps.md from Getting Started to First Steps to match the filename.
  • Add contributing guide to the documentation.
  • Add a shorter version of the Applications of data valuation in machine learning blog post to the documentation with the help of Claude.
  • Move Examples to their own section to make them more visible.
  • Expand the table of content to make all sections visible.
  • Set default documentation theme based on the system's preference.
  • Installs memcached extra in all tox test environments (some notebooks were failing because of this).
  • Remove outdated deprecation warnings.

Checklist

  • Wrote Unit tests (if necessary)
  • Updated Documentation (if necessary)
  • Updated Changelog
  • If notebooks were added/changed, added boilerplate cells are tagged with "tags": ["hide"] or "tags": ["hide-input"]

@AnesBenmerzoug AnesBenmerzoug self-assigned this Jan 24, 2024
Copy link
Collaborator

@mdbenito mdbenito left a comment

Choose a reason for hiding this comment

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

Nice. I left a couple of comments and additions. Do you plan to take care of the other forgotten deprecations, or leave that for another PR?

mkdocs.yml Outdated Show resolved Hide resolved
docs/value/applications.md Show resolved Hide resolved
docs/value/applications.md Outdated Show resolved Hide resolved
Co-authored-by: Miguel de Benito Delgado <[email protected]>
@AnesBenmerzoug
Copy link
Collaborator Author

I took care of the simple ones only in order to be able to finish this PR for the next release.

Copy link
Collaborator

@mdbenito mdbenito left a comment

Choose a reason for hiding this comment

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

One small fix and also we should probably delete the subsection on applications within the introduction, or merge it with applications.md in case it adds something.

docs/value/applications.md Outdated Show resolved Hide resolved
@AnesBenmerzoug
Copy link
Collaborator Author

I merged the two sections into one and then decided to remove more deprecated code and updated the tests accordingly.

Copy link
Collaborator

@mdbenito mdbenito left a comment

Choose a reason for hiding this comment

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

Nice.

@AnesBenmerzoug AnesBenmerzoug merged commit 5656be0 into develop Jan 26, 2024
18 checks passed
@mdbenito mdbenito deleted the fix/docs-and-cleanup branch February 13, 2024 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants