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

[sdk docs] Added mermaid ref #19528

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Conversation

ronny-mysten
Copy link
Contributor

@ronny-mysten ronny-mysten commented Sep 24, 2024

Description

Was unable to build site locally to test. Trying to get mermaid graph to render here: https://sdk.mystenlabs.com/typedoc/index.html

Test plan

https://sui-typescript-docs-7fcypvvd6-mysten-labs.vercel.app/typedoc/index.html


Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

@ronny-mysten ronny-mysten requested a review from a team as a code owner September 24, 2024 21:13
Copy link

vercel bot commented Sep 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 26, 2024 3:12pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 3:12pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 3:12pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 3:12pm

@hayes-mysten
Copy link
Contributor

hayes-mysten commented Sep 25, 2024

it looks like this isn't working. I think this plugin might only apply to the typedoc comments, and not the the readme. I think the real issue is this readme isn't actually relevant to the sdk docs

ignore this, its working correctly:

https://sui-typescript-docs-git-fork-ronny-mysten-qf-80bb65-mysten-labs.vercel.app/typedoc/index.html

@hayes-mysten
Copy link
Contributor

hayes-mysten commented Sep 25, 2024

The logo isn't rendering correctly, we probably need to change the image at the top of the readme at the root of the repo to https://raw.githubusercontent.com/MystenLabs/sui/refs/heads/main/docs/site/static/img/logo.svg (using the raw url rather than the github url directly, which can't be rendered externally)

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

Successfully merging this pull request may close these issues.

2 participants