Skip to content

Cleanup of links out to the ValidMind Library docs#331

Merged
validbeck merged 11 commits intomainfrom
beck/sc-8728-followup
Mar 11, 2025
Merged

Cleanup of links out to the ValidMind Library docs#331
validbeck merged 11 commits intomainfrom
beck/sc-8728-followup

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Mar 7, 2025

Internal Notes for Reviewers

Follow-up to validmind/documentation#668:

EDIT:

Added an intro block to 101 as I liked the beginnings of the one Michael added in the validator notebook:

Screenshot 2025-03-11 at 1 45 08 PM

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.

LGTM, just a minor comment you can commit. 🚀

Related, we likely should set up a redirect for https://docs.validmind.ai/developer/ (and https://docs.validmind.ai/guide/, similar to how we already do this for the training portal.

validbeck and others added 2 commits March 11, 2025 15:30
@github-actions
Copy link
Contributor

PR Summary

This pull request updates various documentation links across multiple files in the project. The changes involve updating the URL paths from get-started-validmind-library.html to validmind-library.html in markdown files, Jupyter notebooks, and R markdown files. This change ensures that all references to the ValidMind Library documentation are consistent and point to the correct location.

The affected files include:

  • README.md
  • README.pypi.md
  • Various Jupyter notebooks in the notebooks/code_samples and notebooks/how_to directories
  • R markdown files in the notebooks/code_sharing/r directory

These updates are intended to improve the accuracy and accessibility of the documentation links for users exploring the ValidMind Library resources.

Test Suggestions

  • Verify that all updated links in markdown files and Jupyter notebooks correctly navigate to the intended ValidMind Library documentation page.
  • Check that there are no broken links in the affected files after the update.
  • Ensure that the documentation renders correctly in both markdown and Jupyter notebook formats.
  • Test the navigation within Jupyter notebooks to confirm that internal links (e.g., table of contents) are still functional.

@validbeck validbeck merged commit e3d219a into main Mar 11, 2025
6 checks passed
@validbeck validbeck deleted the beck/sc-8728-followup branch March 11, 2025 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants