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: add node api migration docs #5830

Merged
merged 6 commits into from
Feb 29, 2024
Merged

Conversation

psychedelicious
Copy link
Collaborator

@psychedelicious psychedelicious commented Feb 29, 2024

What type of PR is this? (check all applicable)

  • Documentation Update

Description

  • Update mkdocs config
  • Add mkdocstrings to auto-document invocation context
  • Fix some invocation context arg names (sorry, this should be in a separate PR but I wanted to test the docs generation together)
  • Add docs for v3 -> v4 migration and the public API

QA Instructions, Screenshots, Recordings

image
  • pip install -e ".[docs]" to get latest deps, you may need to add --force-reinstall` to get updated versions
  • mkdocs serve to generate and browse the new docs - they are under Workflows & Nodes

Merge Plan

This PR can be merged when approved

[optional] Are there any post deployment tasks we need to perform?

Ensure that the docs page updates - we may need to manually kick that off once next merges to main.

@github-actions github-actions bot added documentation Improvements or additions to documentation python PRs that change python files Root PythonDeps invocations PRs that change invocations services PRs that change app services labels Feb 29, 2024
@hipsterusername hipsterusername merged commit 7cfbe5a into next Feb 29, 2024
7 of 8 checks passed
@hipsterusername hipsterusername deleted the psyche/docs/add-migration-docs branch February 29, 2024 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation invocations PRs that change invocations python PRs that change python files Root services PRs that change app services
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants