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

Add auto-generated docs to the monorepo #197

Merged
merged 75 commits into from
Aug 16, 2024
Merged

Add auto-generated docs to the monorepo #197

merged 75 commits into from
Aug 16, 2024

Conversation

wjthieme
Copy link
Member

@wjthieme wjthieme commented Aug 12, 2024

Goal is to deploy them to github pages using GH actions. They are all built on-demand. The actual docs part is not filled out but most important is that we have parity with the current docs (legacy-sdk) which it does

Screenshot 2024-08-15 at 5 30 15 PM

Screenshot 2024-08-15 at 5 40 34 PM

@wjthieme
Copy link
Member Author

Looks like github wiki is pretty limited in what it can do with linking pages together. Let me investigate if there is a better alternative

@wjthieme
Copy link
Member Author

Used Docusaurus to create a place for docs and guides. This we will then still deploy to GH pages. Might be nice to add an orca.so subdomain to it as well at some point

Base automatically changed from wjthieme/lint-stages to main August 15, 2024 20:02
@wjthieme wjthieme requested a review from philcchen as a code owner August 15, 2024 20:02
# Conflicts:
#	.github/dependabot.yml
#	.github/workflows/checks.yml
#	.gitignore
#	legacy-sdk/whirlpool/src/impl/whirlpool-client-impl.ts
#	package.json
#	programs/whirlpool/package.json
#	rust-sdk/client/kinobi.js
#	rust-sdk/client/package.json
#	rust-sdk/whirlpool/package.json
#	ts-sdk/client/kinobi.js
#	ts-sdk/client/package.json
#	ts-sdk/lint/eslint.config.js
#	yarn.lock
# Conflicts:
#	yarn.lock
@wjthieme wjthieme requested a review from yugure-orca August 15, 2024 20:14
Copy link
Collaborator

@yugure-orca yugure-orca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM🚀

@wjthieme wjthieme merged commit db0bbd4 into main Aug 16, 2024
5 checks passed
@wjthieme wjthieme deleted the wjthieme/docs branch August 16, 2024 01:39
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

Successfully merging this pull request may close these issues.

2 participants