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

Host generated documentation #7

Open
Jipperism opened this issue Jan 19, 2024 · 1 comment
Open

Host generated documentation #7

Jipperism opened this issue Jan 19, 2024 · 1 comment

Comments

@Jipperism
Copy link
Collaborator

Setup hosting for the generated documentation of the marketplace SDK.

Follow this example: https://github.com/hypercerts-org/hypercerts/blob/main/docs/docusaurus.config.js

@Jipperism
Copy link
Collaborator Author

@bitbeckers did some research into this and there are some decisions we'd have to make. It comes down to us having 2 options:

  1. Host the marketplace-sdk documentation standalone somewhere. The benefits are that it would be very easy to set up, for example just link it to some github pages.
  2. Integrate it into the existing docs on hypercerts.org.

I'd say that the second option is preferable. As far as I can tell, there is no support within docusaurus atm to keep the current setup, but pull in docs from a different repo as well. A more comprehensive answer can be found here: https://stackoverflow.com/a/70978082.

A different solution would entail setting up some sort of workflew in the docs:deploy script in the hypercerts repo, that clones the marketplace-sdk repo and copies over the generated docs files. It seems a bit more brittle, but might be good enough for the time being.

Also turning this into a discussion with an eye on the proposed rewrite of the frontend. Not sure whether this would live in the same mono repo or would bit split off into a separate one. If it will be, that might be an argument for setting up more sophisticated support for hosting docs from multiple at same time.

A last option would be to run a very similar script to the one referenced in the original issue but for a different subdomain.

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

No branches or pull requests

1 participant