Update API host URL to prod in reference

[validbeck]

Pull Request Description

What and why?

Will resolve the issue noted by @nibalizer in this Slack thread when merged and changes pulled into docs.

How to test

I pulled in this branch into docs and rendered the built API docs again:

What needs special review?

• make docs still throws weird errors for me locally, but everything should be there. . .
• make quarto-docs worked fine, but please double-check just in case?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

• What and why
• Screenshots or videos (Frontend)
• How to test
• What needs special review
• Dependencies, breaking changes, and deployment notes
• Labels applied
• PR linked to Shortcut
• Unit tests added (Backend)
• Tested locally
• Documentation updated (if required)
• Environment variable additions/changes documented (if required)

[nibalizer]

Question: why is this a 65k line PR

[nrichers]

@validbeck thank you for making this update! Before I review more thoroughly, some changes are needed:

• Remove the defunct pdoc HTML output files, they are no longer being generated (and they would have been generated by a workflow anyway)
• Remove the QMD files, as they get generated and committed as part of quarto-docs.yaml which runs on its own

Note the Quarto workflow appears to have failed with this error for some time, likely because of a branch protection that was added. I'll follow up.

remote: error: GH006: Protected branch update failed for refs/heads/main.
remote:
remote: - Changes must be made through a pull request.
error: failed to push some refs to 'https://github.com/validmind/validmind-library'

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ validbeck
❌ nrichers
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[nrichers]

@nibalizer related to this Slack DM, I changed the workflow that is causing issues to create PRs instead of committing directly to main. This version requires enabling auto-merge, would that be OK?

EDIT: afff438

[validbeck]

Remove the defunct pdoc HTML output files, they are no longer being generated (and they would have been generated by a workflow anyway)
Remove the QMD files, as they get generated and committed as part of quarto-docs.yaml which runs on its own

Gotcha, I wasn't sure on either of these since the READMEs don't seem to have been updated to reflect these processes are covered — can we all maybe a callout or something to both the top-level README and the docs README?

[validbeck]

@nrichers Sorry, it wouldn't let me checkout docs directory to main cleanly so I force-pushed to older commits. You'll need to reapply your edits.

[nrichers]

Gotcha, I wasn't sure on either of these since the READMEs don't seem to have been updated to reflect these processes are covered — can we all maybe a callout or something to both the top-level README and the docs README?

We do have this in the docs/ readme:

.github/quarto-docs.yaml — Generates and commits Quarto Markdown docs

I guess we could be more explicit but since no user interaction is needed, there aren't really steps to follow?

[nrichers]

@validbeck your changes LGTM 🚀 but the workflow changes I pushed need input from Spencer before we can call them done (either remove the auto-merge lines and do stuff more manually OR enable auto-merge on the repo).

[validbeck]

I guess we could be more explicit but since no user interaction is needed, there aren't really steps to follow?

This is what is in the top-level README with no additional context:

[nrichers]

This is what is in the top-level README with no additional context

Proving yet again that @validbeck not only writes excellent docs but also reads them. Removed in b6c7088

[validbeck]

Proving yet again that @validbeck not only writes excellent docs but also reads them. Removed in b6c7088

Thank you — I wasn't sure if I was just lost! Maybe we can put a little note in the docs/README that when you test the generation locally you shouldn't commit the files because that's taken care of by the workflow.

EDIT: Actually, why are the builds committed to the .gitignore file? 🤔

[github-actions]

PR Summary

This PR introduces two main categories of changes:

1. Workflow Enhancement for Documentation Generation:

   • The GitHub Actions workflow (.github/workflows/quarto-docs.yaml) has been updated to use the peter-evans/create-pull-request action instead of the previous add-and-commit action. This change automates the creation of a pull request for generated Quarto documentation updates rather than directly committing those changes.
   • Relevant parameters have been updated, such as setting a dedicated branch name (quarto-docs-update) and adding paths for the docs directory. The auto-merge step is provided as commented-out code, offering flexibility for future workflow enhancements.

2. API Endpoint Updates for Production:

   • Several R notebooks and R-related files have been modified to update the API host URLs from the development endpoint (https://api.dev.vm.validmind.ai/api/v1/tracking) to the production endpoint (https://app.prod.validmind.ai/api/v1/tracking).
   • This change affects files in the notebooks directory as well as documentation and initialization code in the validmind package, ensuring that examples and internal documentation point to the correct production environment.

Additionally, the .gitignore has been updated to ignore HTML and QMD files, likely to prevent auto-generated or intermediary files from being committed.

Test Suggestions

• Run the GitHub Actions workflow to verify that a pull request is properly created with updated documentation when changes occur.
• Manually verify that a new branch named 'quarto-docs-update' is created and cleaned up after the PR is merged.
• Test the generated Quarto documentation locally to ensure that the changes in file ignoring and automated updates are working as expected.
• Run the R notebook examples to confirm that the new production API endpoints are correctly used and that the functionality remains intact.

[nrichers]

@validbeck approved - as discussed, I added HTML and QMD files to the .gitignore and commented out the workflow step that requires auto-merge to be enabled. Feel free to merge at your leisure.