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

docs generation #316

Closed
mixmix opened this issue Apr 17, 2024 · 4 comments
Closed

docs generation #316

mixmix opened this issue Apr 17, 2024 · 4 comments
Assignees
Labels
build-chain ugggh the hole

Comments

@mixmix
Copy link
Collaborator

mixmix commented Apr 17, 2024

  • docs/ used to be auto-generated?
  • where is the script that does that
  • why is docs/ not gitignored?
@ameba23
Copy link
Contributor

ameba23 commented Apr 25, 2024

Im not sure whether auto generated docs ever got setup for this repo. At some point, we were manually building all API docs, using this script and deploying them here - which is either out of date or 404s.

For all our other repos we then setup automated docs building with vercel, but we never got around to doing it for the SDK. Now we have ditched vercel in favour of publishing our crates publicly which means docs will get automatically. But im not sure if there is a plan for how to do that for this repo.

@frankiebee
Copy link
Collaborator

I didnt setup automated docs on purpose. I'd like @johnnymatthews to way in on this. when he and i talked he wanted to move them over manually for now.

@frankiebee
Copy link
Collaborator

closing in favor of #324

@johnnymatthews
Copy link
Contributor

Ya, to be clear: we wanna automate docs at some point in the future. But since testnet is 2 weeks away, I'm gonna focus on docs creation rather than backend docs-infra stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-chain ugggh the hole
Projects
None yet
Development

No branches or pull requests

4 participants