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

♻️ Content - .md to .mdx #1627

Open
2 tasks
bradystroud opened this issue Nov 11, 2024 · 0 comments
Open
2 tasks

♻️ Content - .md to .mdx #1627

bradystroud opened this issue Nov 11, 2024 · 0 comments
Labels
Type: Refactor A code quality improvement e.g. Tech debt

Comments

@bradystroud
Copy link
Member

bradystroud commented Nov 11, 2024

We need to change all the rules content to MDX.
Read more about when to use MDX - https://www.ssw.com.au/rules/mdx-vs-markdown/

We need a script to migrate all the content (.NET Console app)

Unfortunately, the script cannot be written until we have built the components (e.g. greybox) See - #1629

This is how development should go

  1. MDX component is migrated
  2. Script - add a function that finds all the old ::: component and converts them to MDX
  3. Updated script is tested and run on a branch of the rules content
  4. The updated content and script is committed to the branch
  5. This triggers a deploy to a staging environment

Eventually this branch will be merged into main, when you can search in vs code and there are no more :::

Tasks

Preview Give feedback
@bradystroud bradystroud added the Type: Refactor A code quality improvement e.g. Tech debt label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Refactor A code quality improvement e.g. Tech debt
Projects
None yet
Development

No branches or pull requests

1 participant