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: refactoring + mermaid support & new-docs #20

Merged
merged 5 commits into from
May 24, 2024

Conversation

Neilblaze
Copy link
Member

Description

  • Added Technical Fork into the metrics section.
  • Updated Contributing guide (linked Mermaid Diagram getting-started guide)
  • Updated Docs (user_docs), added mermaid diagrams for UML figures & shifted default examples into dropdowns.
  • Added support for tap-to-zoom on markdown images using image-zoom docusaurus plugin.
  • Refactored Blockquote styling to enhance visibility.

Ref : Slack Discussion / cc: @frank-zsy
Partially resolves #11 > Deployed URL 🚀

Before submitting the PR, please take the following into consideration

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. If you don't have an issue, please create one.
  • Prefix your PR title with feat: , fix: , chore: , docs:, or refactor:.
  • The description should clearly illustrate what problems it solves.
  • Ensure that the commit messages follow our guidelines.
  • Resolve merge conflicts (if any).
  • Make sure that the current branch is upto date with the main branch.

@Neilblaze
Copy link
Member Author

Neilblaze commented May 21, 2024

Adding a note that, this & this might create a merge conflict, since I forgot performing cherry picking from the update-vX branch (on my local), so simply ignore it by accepting all incoming changes.

@frank-zsy
Copy link
Contributor

/preview

Copy link

🪧The website for this PR is deployed at https://open-digger.cn/pull_20/

@frank-zsy
Copy link
Contributor

Oh, I forgot that in Docusaurus we need to set the base URL properly. Will fix the workflow soon.

@Neilblaze
Copy link
Member Author

Haha, no worries! 😄
@frank-zsy I have a worker that deploys from my local everytime I create PR, and for now, you can access the deployed preview from here!

sidebars.js Outdated Show resolved Hide resolved
@frank-zsy
Copy link
Contributor

Haha, no worries! 😄 @frank-zsy I have a worker that deploys from my local everytime I create PR, and for now, you can access the deployed preview from here!

Cool, how do you do this in local env? Do you need to modify the base URL on building?

@Neilblaze
Copy link
Member Author

Neilblaze commented May 22, 2024

Cool, how do you do this in local env? Do you need to modify the base URL on building?

@frank-zsy It's a very simple hack — I just wrote a shell script followed by an alias ("buildRun") to trigger a deploy preview on netlify. So essentially every time I perform buildRun on the terminal, it does npm run build & takes the build folder and overrides the previously deployed build file (on my subdomain), and the cool part is that, since the path and domain remains the same, the overriding performed does purge all previously stored cache duing the previous build, so it's fresh everytime!

@Neilblaze
Copy link
Member Author

@frank-zsy made the changes, preview it here 🚀

Signed-off-by: neilblaze <[email protected]>
@Neilblaze
Copy link
Member Author

@frank-zsy PTAL!

Signed-off-by: frank-zsy <[email protected]>
@frank-zsy
Copy link
Contributor

@Neilblaze I have made a bit change in the title because the Chinese version should to be translated.

LGTM and thanks for the start.

@frank-zsy frank-zsy merged commit e199d67 into X-lab2017:master May 24, 2024
1 check passed
@Neilblaze
Copy link
Member Author

@frank-zsy Oh my bad, yes, i18n should be the folder where I keep the EN variant and the default docs should have the To be Translated label since the defaultLocale is ZH, thanks for the edit!

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.

2 participants