-
-
Notifications
You must be signed in to change notification settings - Fork 3
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
feat: Migrate Docs to Docusaurus #481
Conversation
* 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
* feat: add ctg procedure to sidebar
…-Docs into feat/migrate-to-docusaurus
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! 😊 |
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! |
Linked Issue
Closes #454
Description
This PR moves our documentation to Docusaurus for easy access and better maintenance. It holds below changes:
pnpm
for consistency with vcio websitedocs
folderh1
to clarify the contentsScreen Recording
How to Test Locally
feat/migrate-to-docusaurus
) to your local machinepnpm install
to install dependenciespnpm start
to run Docusaurusdocs
folder is a duplication from existing README with adjusted linkssidebar.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