-
Notifications
You must be signed in to change notification settings - Fork 8
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
Docusaurus test run #267
base: develop
Are you sure you want to change the base?
Docusaurus test run #267
Conversation
This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## develop #267 +/- ##
========================================
Coverage 66.65% 66.65%
========================================
Files 56 56
Lines 4666 4666
========================================
Hits 3110 3110
Misses 1384 1384
Partials 172 172
Flags with carried forward coverage won't be shown. Click here to find out more. |
@@ -0,0 +1,6 @@ | |||
export default [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are we sure these imports work in the pipeline or whereever these are needed? Since they seem to access your local device.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 seems like these should be done as relative paths if possible?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything in the .docusaurus/
dir is temp files autogenerated based mainly on contents in docusaurus.config.js
. I'm not sure which piece of config generates this specifically, but the js file is where we should look.
"title": "Recent posts", | ||
"items": [ | ||
{ | ||
"title": "Welcome", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we want to delete these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok I guess this is just a "hello world" to see if Docusaurus is successfully deployed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aside from the noted 'kclay' paths, I'm thinking this is looking mature enough that we could probably merge, and I can get CI setup with Vercel so that we can have preview deployments etc. Approving for now since there should be no real user-facing impact other than the new files in the repo.
@@ -0,0 +1,6 @@ | |||
export default [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 seems like these should be done as relative paths if possible?
📋 Add associated issues, tickets, docs URL here.
Overview
We're testing out a docusaurus as a doc provider over gitbook. This is a smaller collection of ported over docs to see how it could go.
Changes
Added a whole docusaurus version of the docs
Testing
Navigate to the new
boba-docs
dir and runyarn start
to render the docs locally.