Try docusaurus for docs #33
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robotrapta
approved these changes
Apr 3, 2023
| @@ -0,0 +1,47 @@ | |||
| name: docs | |||
Member
There was a problem hiding this comment.
Suggested change
| name: docs | |
| name: docs | |
| # Builds the documentation website and publishes it to https://groundlight.github.io |
As we rely more on GHA, we should get in the habit of writing docstrings at the top for what they do.
Comment on lines
+3
to
+4
| This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. | ||
|
|
Member
There was a problem hiding this comment.
Of course we'll want to update all this sample stuff.
Member
There was a problem hiding this comment.
I don't want to have a "blog" right now. We should build a place to put blog-like articles, but I don't want them to be presented that way.
tyler-romero
approved these changes
Apr 3, 2023
Contributor
tyler-romero
left a comment
tyler-romero
left a comment
There was a problem hiding this comment.
LGTM! I like that we can just write markdown to create docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check it out here: https://groundlight.github.io/python-sdk/docs/getting-started
We now have a github action that will build and deploy the site to github pages. We can change the URL to something like
docs.groundlight.aiwhen we're ready. And maybe host it on Netlify or Vercel.