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

Refresh README elements including broken links #240

Merged
merged 4 commits into from
Apr 1, 2024

Conversation

kieran-ryan
Copy link
Member

🤔 What's changed?

  • Fixed broken links
  • Updated commented language names of samples to headers
  • Updated language test statuses to live GitHub workflow badges
  • Updated all diagrams to Mermaid

⚡️ What's your motivation?

  • Several links were broken, including https://ndjson.org which although appeared to be an official link, is now being used for link farming (e.g. links to gambling sites)
  • Change commented language names in sample code blocks to headers allows users to link and share to them directly
  • Live test status badges is perhaps a more succinct and accurate (live) reflection of language test status
  • The AST diagram is now in mermaid. Updated the rest to mermaid for consistency and as it may be easier to update and maintain.

🏷️ What kind of change is this?

  • 📖 Documentation (improvements without changing code)

♻️ Anything particular you want feedback on?

  • Is there anything particularly outdated in the changes that should be updated with this change? e.g. the diagrams
  • Anything that should be split from this PR or perhaps inadvisable to change at this time?

📋 Checklist:


This text was originally generated from a template, then edited by hand. You can modify the template here.

Copy link
Contributor

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the cleaning up!

@kieran-ryan kieran-ryan merged commit ff19fc3 into main Apr 1, 2024
1 check passed
@kieran-ryan kieran-ryan deleted the mermaid-architecture branch April 1, 2024 11:20
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