search

xmtp / xmtp-dot-org

xmtp.org, powered by Docusaurus
https://xmtp.org
MIT License
11 stars 25 forks source link

Enable xmtp-js reference TypeDocs to generate to correct location #36

Closed jhaaaa closed 1 year ago

jhaaaa commented 2 years ago

The goal is to publish some form of https://xmtp-js.pages.dev/ to Docs > Client SDK > Reference on xmtp.org.

I say "some form" because we don't need the XMTP-JS content that appears on the landing page of https://xmtp-js.pages.dev/ to be published as a part of the references. This is the README from xmtp-js, which we already have covered.

We just need the Legend from the bottom of the landing page, https://xmtp-js.pages.dev/modules, and the pages accessible from the Exports right nav.

I don't yet know if the following controls shown in the header are meaningful to our TypeDocs:

Image

These are TypeDocs generated from https://github.com/xmtp/xmtp-js.

See this note from Saul about how we might accomplish this: https://github.com/xmtp-labs/hq/issues/568#issuecomment-1157954377

jhaaaa commented 2 years ago

Enabled by https://github.com/xmtp/xmtp-dot-org/issues/4

jhaaaa commented 1 year ago

obsolete - we have returned to providing ref docs solely on https://xmtp-js.pages.dev/modules and docs are already autogenerating there.