Documentation update #36
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
mjvogelsong
approved these changes
Apr 12, 2023
Contributor
mjvogelsong
left a comment
mjvogelsong
left a comment
There was a problem hiding this comment.
Great changes! My main request is to switch the branch.
.github/workflows/publish-docs.yaml
Outdated
| - .github/workflows/** | ||
| - docs/** | ||
| branches: | ||
| - docs |
Contributor
There was a problem hiding this comment.
(Talked offline) Let's change the branch pointers back to main. I think a separate branch for docs would be confusing.
Comment on lines
+30
to
+35
| Some more resources you might like: | ||
|
|
||
| * [Code Documentation](https://code.groundlight.ai/) | ||
| * [Python SDK](https://pypi.org/project/groundlight/) | ||
| * [Company](https://www.groundlight.ai/) | ||
| * [Login to Groundlight](https://app.groundlight.ai/) |
Contributor
There was a problem hiding this comment.
In fact, I do like them!
docs/docusaurus.config.js
Outdated
| organizationName: "groundlight", // Usually your GitHub org/user name. | ||
| projectName: "python-sdk", // Usually your repo name. | ||
| deploymentBranch: "gh-pages", // Branch that GitHub pages will deploy from. | ||
| deploymentBranch: "docs", // Branch that GitHub pages will deploy from. |
Contributor
There was a problem hiding this comment.
I'm not 100% sure, but I think we want to switch this back to gh-pages.
Co-authored-by: Michael Vogelsong <4020875+mjvogelsong@users.noreply.github.com>
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.
Decently sized documentation update. Getting rid of a lot of docusaurus boilerplate stuff. Some new content. Some re-arranging. More to come.