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.

Sign up for GitHub

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

Jump to bottom

Create PoC for SDK Docs #181

Open
johnnymatthews opened this issue Jul 30, 2024 · 2 comments
Open

Create PoC for SDK Docs #181

johnnymatthews opened this issue Jul 30, 2024 · 2 comments
Assignees
@johnnymatthews

Comments

@johnnymatthews
Copy link
Collaborator

johnnymatthews commented Jul 30, 2024 •
edited
Loading

The JS team have created sdk.docs.entropy.xyz to show the alpha documentation for the alpha SDK releases. It's a good starting point!

However, it'd be great to keep all reference documentation (like the SDK docs and CLI docs) within docs.entropy.xyz. This task should serve as a proof of concepts to take the Typedoc program the sdk.docs.entropy.xyz site is using, and output markdown files that we can use within this repo.

test/sdk-ref-docs-poc is the working branch for this issue.
@johnnymatthews johnnymatthews self-assigned this Jul 30, 2024
@johnnymatthews
Copy link
Collaborator Author

Threw a quick preview over on Netlify. Here's what it looks like so far: https://66aa4f8e3b37a407f6bc448c--preeminent-blancmange-112fb3.netlify.app/reference/sdk/

@johnnymatthews
Copy link
Collaborator Author

Putting back into Backlog until the offsite where we can work on this together with the JS team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnnymatthews johnnymatthews

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johnnymatthews