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

Documentation of Open Innovation Platform #1

Open
1 of 6 tasks
BatoolMM opened this issue Jan 21, 2024 · 1 comment
Open
1 of 6 tasks

Documentation of Open Innovation Platform #1

BatoolMM opened this issue Jan 21, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BatoolMM
Copy link
Member

BatoolMM commented Jan 21, 2024

Enhancing the Open Innovation Platform Documentation with Multilingual Support

We are currently developing an experimental repository aimed at establishing a comprehensive documentation platform for the Open Innovation Platform. This work leverages the capabilities of Quarto and the babelquarto package to provide robust multilingual support, specifically catering to both Arabic and English languages.

Local Building Instructions:
To build the documentation book locally, you can utilise the babelquarto::render_book() function in R. Please note that the integration with GitHub Pages is still under development and not operational as of now. It is deployed via Netlify now.

Immediate Objectives for the Demo Version:
To progress towards a functional demo version of the documentation, we have outlined the following key steps:

  • Arabic Language Support: Ensure effective deployment of the Arabic version, with a focus on Right-to-Left (RTL) text alignment. This may require the development of custom CSS. I have added few Arabic files to test it.
  • Deployment Solutions: Although deployment is working but when you click on Arabic version, it's not working - same with local build.
  • Outline documentation structure #2 : Develop a structured framework for the new documentation.
  • Content Migration: Transfer all existing documentation from JSDocs to the new platform.
  • Crowdin Integration and Quarto Deployment: Set up a new Crowdin project to manage translations. It's crucial to ensure that Quarto successfully deploys translations from the new file structure. Currently, there seems to be a challenge with deploying translations, as both English and Arabic versions should be accessible from the same file path.
  • Arabic Localisation: Complete the localisation of all documentation into Arabic.
@BatoolMM
Copy link
Member Author

Fixed Arabic deployment, it's working now.

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

No branches or pull requests

3 participants