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

[24-01-2024] Migrated existing doc from md to quarto #3

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

RealRichi3
Copy link
Member

This PR includes the new documentation in Quarto markdown language. The doc was originally in md and some sections were auto generated by JSDOC

This migrates the existing doc to Quarto, it includes the tutorial files, contribution guides and other documentation excluding the auto generated docs by JSDOC

Partial fix for #2

This migration includes the tutorial files, contribution guides and other documentation excluding the auto generated docs by JSDOC
Copy link

netlify bot commented Jan 24, 2024

Deploy Preview for open-innovation-docs ready!

Name Link
🔨 Latest commit 07f6581
🔍 Latest deploy log https://app.netlify.com/sites/open-innovation-docs/deploys/65bc148dfd75310008e5e42b
😎 Deploy Preview https://deploy-preview-3--open-innovation-docs.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.

Copy link

the-label-bot bot commented Jan 24, 2024

The Label Bot has predicted the following:

Category Value Confidence Applied Label
Kind documentation 0.991 ✔️
Size XXL 0.642 ✔️

@the-label-bot the-label-bot bot added the kind/documentation kind/documentation label Jan 24, 2024
@RealRichi3 RealRichi3 requested a review from BatoolMM January 24, 2024 17:39
_quarto.yml Outdated
text: "Version in ar"
mainlanguage: 'en'
languages: ['ar']
- name: en
Copy link
Member

Choose a reason for hiding this comment

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

Why did change the spaces here?

Copy link
Member

@BatoolMM BatoolMM left a comment

Choose a reason for hiding this comment

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

Thank you @RealRichi3 - I think we shouldn't add them in book_en. The Arabic files should be at the same directory path. Can you create dummy Arabic files (2-3) for some of these and see if it got deployed correctly?

@RealRichi3
Copy link
Member Author

@BatoolMM i've renamed book_en to chapters i didn't add all the chapters in the root dir so it'll be more organised

@BatoolMM
Copy link
Member

@RealRichi3 thank you - the problem is that you it is not deployed in Netlify, also can you double-check the spaces in the YAML, pls?

@RealRichi3
Copy link
Member Author

@RealRichi3 thank you - the problem is that you it is not deployed in Netlify, also can you double-check the spaces in the YAML, pls?

Yea, the spaces look okay here, it rendered here correctly without any errors, i'm still finding a way to render the Arabic version tho. Which command do you use to preview it , is it quarto preview or is there a different command since we included babel?

@BatoolMM
Copy link
Member

@RealRichi3 I didn't mean locally, I meant with Netlify here https://deploy-preview-3--open-innovation-docs.netlify.app/ - you can see the deployment in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation kind/documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants