Updated product terminology — documentation repo side#521
Conversation
…lidmind-library.qmd
PR SummaryThis pull request refactors the documentation to update the naming conventions and references for the ValidMind product and platform. The changes include:
These changes aim to improve clarity and consistency in the documentation, making it easier for users to understand and navigate the ValidMind product offerings. Test Suggestions
|
There was a problem hiding this comment.
LGTM! I have some minor comments or questions but this looks to be a very thorough first pass over our docs site as we change to the new product name. 🚢 🚢 🚢
We will need a release notes entry at some point. Since this is the main PR to update the user guide, I’d recommend including it in this PR. (If there’s still outstanding stuff at the next release, we can always comment it out until ready.)
EDIT: Fix wording.
There was a problem hiding this comment.
While recording the videos for the developer experience I realized that there's a notebook missing from this PR: https://github.com/validmind/documentation/blob/beck/sc-6647/update-product-terminology/site/notebooks/tutorials/intro_for_model_developers_EXECUTED.ipynb
It's that special case again that invariably comes to bite you — this notebook lives only in the documentation repo and is use for the developer fundamentals training.
The underlying issue why we need this notebook still isn't fixed, see the newly opened Fix OAuth error when embedding JupyterHub in training module.
For now, I'm requesting changes to your PR but we might figure out some alternative for this issue if the non-_EXECUTED notebook has diverged from this one substantially. E.g. we could try to execute the on-_EXECUTED notebook on the fly when we run make get-source but we'd need to figure out how to get the code snippet into the notebook via dotenv.
See 5552c3b for my hacky workaround while recording the videos.
|
A PR preview is available: Preview URL |
There's already a story for this: sc-6648 (I was going to wait until the repo was renamed to do this one, as it is technically the final step.) EDIT: Also, in the spirit of our "atomic" PRs, I vote doing this in a second PR just for my sanity's sake. This branch has already been open for a month!
I forgot to add it to the list of "To dos," but I wasn't going to redo this until the notebook it originates from is merged into |
|
A PR preview is available: Preview URL |
nrichers
left a comment
There was a problem hiding this comment.
in the spirit of our "atomic" PRs, I vote doing this in a second PR just for my sanity's sake. This branch has already been open for a month!
Makes sense, let's just make sure it happens.
I forgot to add it to the list of "To dos," but I wasn't going to redo this until the notebook it originates from is merged into main. (I was just going to execute it again and replace it.) I will add it to the list.
Acknowledged, let me re-approve this PR.
|
A PR preview is available: Preview URL |
Internal Notes for Reviewers
LIVE PREVIEW
Major changes
Updated the variable file to reflect new product names & updated the style guide to reflect some additions:
documentation/site/_variables.yml
Line 16 in b1e20d5
Updated any product images that had old terminology:
Added an auto-uppercasing function in our css so that
_quarto.ymlsidenav headers are able to make use of our product variables & still retain the styling:documentation/site/styles.css
Line 529 in b1e20d5
Developer Framework dropdown >
Developer:documentation/site/_quarto.yml
Line 39 in b1e20d5
New
internal/templates/jupyter-notebooksdirectory with.ipynbfilesProofreading of site for awkward phrasing
File renames
Aliases have been set up for the old URLs:
site/developer/get-started-developer-framework.qmdsite/developer/get-started-validmind-library.qmdsite/developer/model-documentation/install-and-initialize-client-library.qmdsite/developer/model-documentation/install-and-initialize-validmind-library.qmdTo do
developer-frameworkGitHub repo URL: Waiting on the repo renamedeveloper-frameworkrepo by name: See previous itemdeveloper-frameworkrepo side for terminology (notebooks, tests, READMES, etc.): Updated product terminology —developer-frameworkrepo side validmind-library#233developer-frameworkrepo side for change doc URLs (get-started-developer-framework.qmd, install-and-initialize-client-library.qmd): Waiting for this PR to be merged & publisheddeveloper-frameworkfirst