Skip to content

docs: add language documentation for AsciiDoc (#769)#809

Merged
hatemhosny merged 7 commits into
live-codes:developfrom
ahmeddelattarr:patch-1
Apr 25, 2025
Merged

docs: add language documentation for AsciiDoc (#769)#809
hatemhosny merged 7 commits into
live-codes:developfrom
ahmeddelattarr:patch-1

Conversation

@ahmeddelattarr
Copy link
Copy Markdown
Contributor

  • Added usage guide, language config, example, and limitations
  • Follows the structured template for language docs

What type of PR is this? (check all applicable)

  • ✨ Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • ♻️ Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert
  • 🌐 Internationalization / Translation

Description

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentations?

  • 📓 docs (./docs)
  • 📕 storybook (./storybook)
  • 📜 README.md
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

- Added usage guide, language config, example, and limitations
- Follows the structured template for language docs
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 24, 2025

Deploy Preview for livecodes ready!

Name Link
🔨 Latest commit 8f20bab
🔍 Latest deploy log https://app.netlify.com/sites/livecodes/deploys/680c0939a15f5900080c5917
😎 Deploy Preview https://deploy-preview-809--livecodes.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hatemhosny
Copy link
Copy Markdown
Collaborator

hatemhosny commented Apr 25, 2025

Thank you @ahmeddelattarr
I appreciate your effort.

I have made some changes for consistency with other language docs:

  • Language description: I tend to add a brief description, ideally from the official source.
  • Added a demo (using your code)
  • The language name: should match the name in specs. This is used in the configuration (and query params) to select the language.
  • Extensions: should match file extensions defined in specs. This is used in importing files (e.g. from GitHub) to identify which language to use, and in exporting source.
  • Editor: defines which editor to use when loading the language (markup in AsciiDoc).
  • Added how to use the Custom Settings
  • Live Reload is a feature that is used in some languages where code changes does not reload the result page, but changes are only sent to the page to be applied. This is used when the language runtime in the page is big and we want to avoid reloading it with every change. This is not used in AsciiDoc, so I removed it.
  • The section for starter template provides a link to the language starter template if present. There is no starter template for AsciiDoc, so I removed it.

I also changed compiler options to show the title and fixed a test to use the new settings.

I hope this gives you an idea about structuring the language docs.
Please review the changes let me know if you have any comments or questions.

@sonarqubecloud
Copy link
Copy Markdown

@ahmeddelattarr
Copy link
Copy Markdown
Contributor Author

Hey, thanks so much for the detailed feedback and for tweaking things to match the documentation standards! I really appreciate the time you took to review my work and explain why the changes were needed. I’ve gone through the updates, and they make total sense "i didn't search enough, my bad". Your guidance is super helpful, and I’m excited to keep these standards in mind for my next contributions!

@hatemhosny
Copy link
Copy Markdown
Collaborator

Thank you @ahmeddelattarr
Merging this now...

Waiting for your next contributions ❤️

@hatemhosny hatemhosny merged commit 870dbc3 into live-codes:develop Apr 25, 2025
15 checks passed
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