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: migrate most JS to TS, migrate to Docusaurus v3, MDX v3 #249

Merged
merged 19 commits into from
Feb 25, 2024

Conversation

PoetaKodu
Copy link
Collaborator

Description

Platform:

  • Upgrade to Docusaurus v3 and MDX v3 which enabled a lot of refactorings and lintings but introduced many breaking changes to v1/v2.
  • Refactored most of JS code to TS
  • Introduced more static checks
  • Cleaned up dependencies

Docs

  • Migrated docs to use MDX v3.
  • Fixed minor problems in MDX docs

Type of Change

Changes in docs (docs)

  • improve(docs) - e.g. added a new paragraph, example, using a better wording, adding a new document, etc.
  • 🛠️ fix(docs) - bug fix, e.g. fix a typo, page render issue
  • BREAKING CHANGE(docs) - e.g. removing a document/article/category that was referenced in many other places
  • 🧹 refactor(docs) - changed a code example, e.g. replaced old code with a modern one
  • 🗑️ chore(docs) - other changes that don't affect the docs, e.g. updating the CI/CD pipeline

Changes in the platform (platform)

  • feat(platform) - a new feature, e.g. a new MDX component, plugin, theme, etc.
  • 🛠️ fix(platform) - bug fix, e.g. fix a typo, issue causing component to crash
  • BREAKING CHANGE(platform) - e.g. removing a feature, changing the API, etc.
  • 🧹 refactor(platform) - code improvements, changes, e.g. unifying style, renaming internals, etc.
  • 📝 docs(platform) - updated code documentation
  • 🗑️ chore(platform) - other changes that don't affect the platform directly, e.g. updating the CI/CD pipeline

@PoetaKodu PoetaKodu merged commit 6859c78 into Cpp4You:main Feb 25, 2024
@PoetaKodu PoetaKodu deleted the chore/update-docusaurus branch February 25, 2024 15:00
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.

1 participant