Nrichers/sc 12743/fix quarto docs workflow issue#1001
Merged
Conversation
11 tasks
nrichers
force-pushed
the
nrichers/sc-12743/fix-quarto-docs-workflow-issue
branch
from
4af27ec to
7e509cc
Compare
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Collaborator
Author
|
@validbeck this PR adds checking out the validmind-library repo to workflows that build our docs site. Essentially, this PR removes the need to store a copy of the Python API docs source in the documentation repo and opens the door to doing the same for notebooks and test descriptions in the future. |
nibalizer
approved these changes
Oct 22, 2025
nrichers
added a commit
that referenced
this pull request
Oct 30, 2025
* Remove validmind/ folder and old python-docs.zip file * Change make python-docs to generate the Python API files * Add site/validmind to the .gitignore * Add make python-docs equivalent to workflows * Try RELEASE_NOTES_RO_PAT
nrichers
added a commit
that referenced
this pull request
Oct 31, 2025
* Removing validmind version variable (#921) * infra: Merge main into staging PRs created by staging deploy now indicate original PR# (#924) * Updating main into staging workflow * Testing branch versions * Removing test file * Fix Makefile help * infra: Delete older PR preview comments from validate & execute flows (#932) * Adding deletion of old preview comments back in * Removing unused variable * Adding same thing to notebooks * Edit to notebook, should remove old comment * hm * Deleting test execution notebook * ValidMind Platform releases: Exclude `admin-ui` from roundup listing page (#933) * Exclude admin-ui from platform releases roundup * Adjust * Remove old variable usage --------- Co-authored-by: Nik Richers <nik@validmind.ai> * docs: Export findings (#939) * Setup: Customize model findings layout * Save point * Save point * Draft: Customize model finding layouts * Setup: Export findings * Draft: Export findings * Export documentation > Export documents * Editing * Cleanup * Proofread * Filter * Update API reference to use prod server (#938) * Update API reference to use prod server * Update Makefile for admin API as well * docs: Export inventory (#943) * Setup: Export inventory * Draft: Export inventory * Proofreading * Oops * docs: Updated Export findings (#944) * Setup * Proofread * Testing pinned Quarto version * docs: Customize Virtual Document Validator (#947) * Set up: Manage regulations and policies * WIP * Customize VDV draft * Edits: Check documentation for compliance * Proofread * Quick UI updates * Pin a Quarto version specified in Action variables for our deployment workflows (#951) * Testing pinned Quarto version * Applying pinned Quarto version to other workflows * Removing test notebook * docs: Workflow Wait step time delta configuration (#954) * Setup: Wait step time delta * Editing * Updating example screencap for Wait * Remove login button and make related CSS modular (#949) * Remove login button and make related CSS modular * Make login link specific to profile * Change scss/ to assets/style/ and update README.md * Fix double space * Check out .gitignore from main * Minor README.md tweak * One more minor README.md tweak * Add missing backticks * Fix Log In button for developer.css * Minor edits * Slight adjust to CSS in-progress message --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: Updated "Manage model finding fields" (#958) * Edit: DElete model findings * Edit: Manage model finding fields * Editing UI wording * Editing... * Editing...... * Proofreading * Edit * docs: Updated "Manage document templates" (#960) * Draft: Delete document templates * Edit: View document templates * Wrapping up * Stupid broken link * Edit: VDV Findings > Observations (#962) * docs: Update inventory & finding field views (#964) * Edit: Manage model inventory fields * Save point * Edit: Manage model finding fields * Cleanup * Proofread * Adjustments * Final touch * Fix bug in Makefile (#935) * Bug bash: nrichers/sc 12201/disable algolia search on api reference pages (#968) * Disable Algolia search on Public API reference page * Fix stray comment indent * docs: Add shared text blocks to YAML templates (#970) * Setup: Add library blocks to YAML templates * Save point * Save point * Tidying up * docs & training: Virtual Document Validator, regulations & policies set up update (#973) * Draft: Questions from PDF uploads * Training: Setup for regulations & policies * Save point * Save point * Draft: Administrator Fundamentals update * Draft: Developer Fundamentals update * Proofreading * Hiding PDF upload for VDV (#975) * Add system access requirements (#977) * Add initial system access requirements topic * Text edits * More edits * Fix incomplete sentence * Basic version: Improve navigation for Python API and Public REST API (#966) * Apply the basic fixes we agreed on * Remove a:hover experiment * Update .gitignore * Underline specific links only * Address review comments from Beck * Final CSS tweak * Update release_notes_check.py (#981) * Enable release notes checks to post comment with instructions (#984) * Update release_notes_check.yaml * Update release_notes_check.py * Edit: Remove info for add finding via doc section (#978) * docs: Updated Workflows Approval Step info (#979) * Edit: Approval step & condition instructions * Update: Approval Step example * Add Tidy Layout callout * Bump versions to 25.10 & v2.9.5 + public release landing page improvements (#971) * Bump release versions * Add temporary branch ref * Fix Makefile help * Reorder all releases page, bump up length of descriptions shown * Turn older releases into collapsible section * Fix YAML * Fix YAML again * Add pagination style from release notes portal * Add button for all feature highlights & add whitespace * Wording tweak * Run make get-source * All releases page tweaks * Fix broken links * Change heading to Latest features for consistency * Address Beck's sidebar suggestion * Fix date in this repo, too * Add whitespace before heading * Remove the branch ref I had THREE reminders for to remove ... (#991) * docs & training: Calculation Finding Fields (#988) * Draft: Calculation Finding Fields * Draft: Calculation Finding Fields in training * Save point * Cleaning up * Proofreading * Save point * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update _field-types.qmd * Applying Andres's code edit --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Upgrade Tachyons with official codeblock fix & remove our workaround (#995) * Commit regenerated Python API files and bump version (#997) * docs: Workflows for findings (#998) * Setup: Workflows for findings * Renaming Setting up model workflows page * Fixing links * Sidebar link * Renaming directory * Fixing broken links pt2 * Cleaning up... * More cleanup * More * More renaming * Oops * Almost there * Stragglers * One more? * & includes * Save point * Edit: Add new workflows in docs * Edit: Edit existing workflows in docs * Edit: Review active workflows in docs * Edit: Review workflow histories in docs * Save point * Edit: Initiate workflows in docs * Edit: Abort workflows in docs * Edit: Manage workflow tasks * Edit: Transition workflows * More cleaup * Training: Edit Add new workflows * Training: Review active workflows * Training: Review workflow history * Training: Initiate workflows * Training: Reset workflows * Training: Abort workflows * Training: Transition workflows * Proofreading * More proofreading * ooo figured out a neat conditional hack * Editing training slides * Updating single-source templates * docs & training: Updates to model registration UX (#1003) * Edit: Register models in inventory * Quickstart: Register model developer * Quickstart: Register model validator * Updating code snippet images * Updating developer model details image * Updating validation report details image * Admin training: Register demo model * Developer training: Register demo model * Validator training: Register demo model * Cleanup * Proofreading * Edit: Manage model stakeholder types on registration * Edit: Manage model stakeholder types on registration training pt1 * Edit: Manage model stakeholder types on registration training pt2 * Edit * Edit * Pulling in latest notebooks from sibling PR * Nrichers/sc 12743/fix quarto docs workflow issue (#1001) * Remove validmind/ folder and old python-docs.zip file * Change make python-docs to generate the Python API files * Add site/validmind to the .gitignore * Add make python-docs equivalent to workflows * Try RELEASE_NOTES_RO_PAT * docs: Workflows User Action v2 step deadlines (#1005) * Setup: Edits to User Action v2 deadlines * Save point * Save point * Updated example images * Proofread * Formatting * Explicitly install poetry before generating Python API docs --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Setup: Trigger workflow start on date & datetime (#1008) * Remove Slack sign-up page & update community resources (#1010) * Remove Slack sign-up page & update community resources * Minor consistency edit * Remove sign-up hint I added * docs: Manage finding severities (#1013) * Setup: Manage finding severities * Docs: Manage finding severities * Training: Manage finding severities * Cleaning up community page --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
What and why?
This PR removes the Python API docs stored in the documentation repo and replaces them with on-the-fly generation of the same:
site/validmind- Removed from repo as no longer neededmake python-docs- Now uses the cloned validmind-library repo to generate Quarto Markdown for the Python API.gitignore- Updated to ignore the generated Python API files to make sure we don't commit themvalidate-docs-site.yaml,deploy-docs-staging.yaml,deploy-docs-prod.yaml- Now generates Quarto Markdown source for the Python API on the fly, analogous to whatmake python-docsdoesRelates to:
How to test
If this PR works as expected, there should be no change in the output and the Python API should work as expected: LIVE PREVIEW
(No way to test the deploy to staging and prod until this PR merges, but if the PR preview deploy works, the other workflows should as well.)
What needs special review?
Dependencies, breaking changes, and deployment notes
Release notes
Checklist