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

feat: Migrate Docs to Docusaurus #481

Merged
merged 45 commits into from
Mar 19, 2025

Conversation

adiati98
Copy link
Contributor

@adiati98 adiati98 commented Feb 7, 2025

Linked Issue

Closes #454

Description

This PR moves our documentation to Docusaurus for easy access and better maintenance. It holds below changes:

  • Install and use latest version of Docusaurus
  • Use pnpm for consistency with vcio website
  • Move all documentation to the docs folder
  • Restructure and rename some files and folders for consistency (previously some folders and files used capital letters and underscores) and clarity
  • Change some h1 to clarify the contents
  • Remove Table of Contents (TOC) as it's provided by Docusaurus
  • Change GitHub to Docusaurus admonitions

Screen Recording

vc-docs-docusaurus

How to Test Locally

  1. Pull this branch (feat/migrate-to-docusaurus) to your local machine
  2. Run pnpm install to install dependencies
  3. Run pnpm start to run Docusaurus

⚠️ Special Notes

  • This PR doesn't change any content of existing docs
  • The README in the docs folder is a duplication from existing README with adjusted links
  • The keywords in the front matter are generated and haven't been adjusted
  • The old docs are included in the comment in the sidebar.js in case we need it.

We will create separate issues for any changes regarding the above matters to make sure this PR is not going out of the issue's scope.

Methodology

Code of Conduct

By submitting this pull request, you agree to follow our Code of Conduct

* move existing folders into docs folder
…group-to-cms.md

* fix: move guide-to-add-a-coffee-table-group-to-cms.md to coffee-table-groups/guides folder
@adiati98 adiati98 requested review from a team as code owners February 7, 2025 19:33
@adiati98 adiati98 self-assigned this Feb 7, 2025
@adiati98 adiati98 requested a review from BekahHW February 8, 2025 09:30
@BekahHW
Copy link
Member

BekahHW commented Mar 19, 2025

One thing we might want to look at is adding directions on how to run the repo in the ReadMe.

@BekahHW
Copy link
Member

BekahHW commented Mar 19, 2025

Another thing to note is that docusaurus is case sensitive. I've updated it, but wanted to make sure you knew.

image

@BekahHW BekahHW merged commit 16c5741 into Virtual-Coffee:main Mar 19, 2025
@adiati98
Copy link
Contributor Author

One thing we might want to look at is adding directions on how to run the repo in the ReadMe.

I was thinking about adding this once this PR is merged because I want this PR to only move our docs to Docusaurus as is. I'll create a new issue for this! 😊

@adiati98
Copy link
Contributor Author

Another thing to note is that docusaurus is case sensitive. I've updated it, but wanted to make sure you knew.

image

Hmm... This is weird. I didn't get these errors when I ran the project locally. 😅

I thought I've renamed all folders and files to be lowercase for consistency. I might have missed these! Thanks for spotting them!

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.

Feat: Add Docusaurus
2 participants