-
-
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
Open
adiati98
wants to merge
43
commits into
Virtual-Coffee:main
Choose a base branch
from
adiati98:feat/migrate-to-docusaurus
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
feat: Migrate Docs to Docusaurus #481
adiati98
wants to merge
43
commits into
Virtual-Coffee:main
from
adiati98:feat/migrate-to-docusaurus
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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