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 documentation setup #7

Merged
merged 7 commits into from
Oct 23, 2022
Merged

Add documentation setup #7

merged 7 commits into from
Oct 23, 2022

Conversation

handotdev
Copy link
Contributor

Summary

This PR adds the initial setup and configuration for documentation with Mintlify that you can preview at venice.mintlify.com. The setup is designed to work largely with the existing setup and content such as the README.md and docs/next-steps.md

Screen Shot 2022-10-05 at 2 02 44 AM

@vercel
Copy link

vercel bot commented Oct 5, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
venice ✅ Ready (Inspect) Visit Preview Oct 23, 2022 at 9:49AM (UTC)

@tonyxiao
Copy link
Contributor

@hanywang2 Sorry for the delay just getting to this now. are there any status callback from Mintlify that can be hooked up into the build step here?

@tonyxiao
Copy link
Contributor

image

Just noticed this! Sometimes it shows up other times it doesn't seem to show up, not sure why. Further, are there ways to control it such that only `main` branch deploy updates the docs site?

@tonyxiao tonyxiao merged this pull request into useVenice:main Oct 23, 2022
tonyxiao added a commit that referenced this pull request Oct 23, 2022
* Add documentation setup

* Update link to deploy

* Run validate on PRs

* Only run slack webhooks if secret is set

* Only run migration on production

* Adding explicit trigger for synchronized

* Debug validate startup issue

https://github.com/usevenice/venice/actions/runs/3306596384/workflow

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-using-secrets

Co-authored-by: Tony Xiao <[email protected]>
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