Create PoC for SDK Docs

entropyxyz / entropy-docs

Documentation for Entropy.

https://docs.entropy.xyz

GNU Affero General Public License v3.0

3 stars 1 forks source link

Create PoC for SDK Docs #181

Open johnnymatthews opened 2 months ago

johnnymatthews commented 2 months ago

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 commented 2 months ago

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 commented 1 month ago

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