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

Docusaurus test run #267

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Docusaurus test run #267

wants to merge 7 commits into from

Conversation

katieclay
Copy link

📋 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 run yarn start to render the docs locally.

@katieclay katieclay requested a review from jyellick October 23, 2024 18:51
Copy link

github-actions bot commented Nov 7, 2024

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.

@github-actions github-actions bot added the Stale label Nov 7, 2024
@katieclay katieclay removed the Stale label Nov 11, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 26, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.65%. Comparing base (fad2d0a) to head (39aa4a7).
Report is 19 commits behind head on develop.

❗ 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           
Flag Coverage Δ
cannon-go-tests-32 61.88% <ø> (ø)
cannon-go-tests-64 54.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@katieclay katieclay marked this pull request as ready for review December 4, 2024 19:09
@katieclay katieclay requested a review from wsdt December 5, 2024 16:25
@@ -0,0 +1,6 @@
export default [
Copy link
Collaborator

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.

Copy link

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?

Copy link
Author

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",
Copy link
Collaborator

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?

Copy link
Collaborator

@wsdt wsdt left a 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?

Copy link

@jyellick jyellick left a 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 [
Copy link

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?

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.

4 participants