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

feat(client): typedoc docs gen for phoenix-client #6504

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cephalization
Copy link
Contributor

@cephalization cephalization commented Feb 21, 2025

To use:

cd js/packages/phoenix-client
pnpm i
pnpm run docs # builds docs
pnpm run docs:preview # serves docs artifacts on local server

Includes some minor file reorganization, justifying the feat tag

  • Fill out stub github action. Run typedoc command, ship artifacts to some static site host like github pages
  • Figure out domains. Do we need to match some scheme with python sphinx docs?
typedoc.mov

Copy link

pkg-pr-new bot commented Feb 21, 2025

Open in Stackblitz

npm i https://pkg.pr.new/Arize-ai/phoenix/@arizeai/phoenix-client@6504

commit: b8c1b85

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📘 Todo
Development

Successfully merging this pull request may close these issues.

1 participant