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

refactor: update dependencies and change syntax details to support do… #147

Merged
merged 6 commits into from
Jul 12, 2024

Conversation

YUUU23
Copy link
Contributor

@YUUU23 YUUU23 commented Jul 5, 2024

Update honeycomb docs to use Docusaurus 3.0

  • update relative dependencies that Docusaurus 3.0 requires
  • change syntax details according to errors thrown when building
    • sidebars: cannot have version paths appended to it
    • <default-value > : < are taken as JSX in Docusaurus 3.0, so it needs to be wrapped with inline-code
  • extra spaces were deleted when updating automatically

@YUUU23 YUUU23 self-assigned this Jul 5, 2024
@YUUU23 YUUU23 linked an issue Jul 5, 2024 that may be closed by this pull request
@YUUU23
Copy link
Contributor Author

YUUU23 commented Jul 5, 2024

Both test build failing because of broken links are fixed in this issue
Perhaps one solution may be after we merge this PR for the broken link issue and rebase this PR, the builds would pass (?)

@YUUU23 YUUU23 requested a review from RobertGemmaJr July 5, 2024 20:06
Fix link in versioned_docs/version-3.0.0/setup_details.md
Copy link

github-actions bot commented Jul 10, 2024

Visit the preview URL for this PR (updated for commit 9722df4):

https://ccv-honeycomb-docs--pr147-doc-ver-3-fva75vo1.web.app

(expires Fri, 19 Jul 2024 02:36:17 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: d403a110fede5b0308678a87537bf61d0597aef6

@RobertGemmaJr
Copy link
Member

Could you fix this line? It's in the quick_start - I would only worry about fixing it for the current version

image

Copy link
Member

@RobertGemmaJr RobertGemmaJr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small little fix that I saw from the JSX changes. I left a screenshot, I'd do one last sweep of everything but it's just about there!

@YUUU23 YUUU23 requested a review from RobertGemmaJr July 12, 2024 02:38
@YUUU23
Copy link
Contributor Author

YUUU23 commented Jul 12, 2024

Just a small little fix that I saw from the JSX changes. I left a screenshot, I'd do one last sweep of everything but it's just about there!

Should be fixed in the new commit! Thank you for catching this : ) I also did another run through for all the pages in the most recent version, and I think it looks good but let me know if you see anything else that needs to be changed!

Copy link
Member

@RobertGemmaJr RobertGemmaJr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Everything looks perfect 🚀

@YUUU23 YUUU23 merged commit b45a5ed into main Jul 12, 2024
3 checks passed
@YUUU23 YUUU23 deleted the doc-ver-3 branch July 12, 2024 16:57
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.

Upgrade to MDX and Docusaurus v3
2 participants