Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/contribute/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Contribute",
"position": 5,
"link": {
"type": "generated-index",
"description": "Want to help the UniversalPython movement? Here are some ways."
}
}
12 changes: 12 additions & 0 deletions docs/contribute/core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 1
---

# Improving UniversalPython

There are tonnes of interesting challenges which, when solved, can make UniversalPython easier to use and more resilient:
- [ ] In-transpiler translation of sentences (e.g. translating strings)
- [ ] How can we manage imports of packages, and the functions inside of them?
- [ ] Supporting new and old versions of Python

Feel free to share more challenges in our [GitHub Discussions](https://github.com/UniversalPython/UniversalPython/discussions). We're ready for impact.
12 changes: 12 additions & 0 deletions docs/contribute/improve-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 1
---

# Improving the docs

We maintain our docs on GitHub, using Docusaurus. Some important tasks which are pending:
- [ ] Translation of the documentation to different languages
- [ ] Making it easier for people to suggest new words and add them to the dictionary
- [ ] Computer science education, via a YouTube channel or blogs, in Native languages

Feel free to share more tasks in our [GitHub Discussions](https://github.com/UniversalPython/UniversalPython/discussions). We're ready for impact.
11 changes: 11 additions & 0 deletions docs/contribute/translate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 3
---

# Translate into your language

Are you a native speaker of a language and can contribute to making UniversalPython's keywords more accurate? Or want to add an entirely new language to UniversalPython? Look no further.

The list of languages supported are visible [here](https://github.com/UniversalPython/UniversalPython/tree/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages).

Our translations are (currently) managed in the form of [YAML](https://yaml.org/) files, like [this one right here](https://github.com/UniversalPython/UniversalPython/blob/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages/hi/hi_native.lang.yaml). Simply make one for your own language, and share it with us by opening a Pull Request on [our GitHub](https://github.com/UniversalPython/UniversalPython/), or simply sharing it with us on email at info@grayhat.com.pk
8 changes: 8 additions & 0 deletions docs/examples/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Examples",
"position": 4,
"link": {
"type": "generated-index",
"description": "Learn more by checking out code examples of UniversalPython which demonstrate its capabilities."
}
}
7 changes: 7 additions & 0 deletions docs/examples/playground.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 3
---

# Playground

You can try out UniversalPython in our [online playground](https://universalpython.github.io). No installations required, it all runs in your browser!
30 changes: 30 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_position: 2
---

# Installation

Get started with using UniversalPython.

## Before you begin...

You will require:
- Some basic knowledge about Python
- Python 3+ installed in your computer
- Pip 3+ installed in your computer

> We need help in making this documentation more accessible to people of different languages, from around the world. And more easy-to-understand for complete beginners to programming. Reach out to us at info@grayhat.com.pk if you'd like to help, or drop a Pull Request at [our repo](https://github.com/UniversalPython/UniversalPython.github.io).

## Getting Started

Get started with UniversalPython by installing it from PyPI. Our package name is currently "urdupython" (changes to this soon!)

```
pip install urdupython
```

## Installing from source
1. Download the [UniversalPython repo](https://github.com/UniversalPython/UniversalPython/) as a ZIP, or clone it via Git.
2. Open the repo's folder in your Terminal.
3. Run ```pip install -e .```

44 changes: 8 additions & 36 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,18 @@
sidebar_position: 1
---

# Tutorial Intro
# Welcome

Let's discover **Docusaurus in less than 5 minutes**.
Welcome to the UniversalPython documentation! Learn more about UniversalPython, the motivation behind it, and how it works.

## Getting Started
## Our vision

Get started by **creating a new site**.
We know how hard it is to know multiple languages and get started with computer science and programming. Almost all the material you search for, all the books, videos, and even all of the major programming languages of world, are in English. Did you know that only 27% of the entire world's population knows English? How does the rest of the world learn? This is something we have yet to understand.

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
## History

### What you'll need
UniversalPython started off as UrduPython; the idea of a young student in NUCES, Islamabad, Pakistan. The motivation is simple; programming languages have a basic syntax comprising of "keywords". If there was a basic mapping of those keywords into other languages, the people of Pakistan (a country of **77 established languages**) could learn programming much better.

- [Node.js](https://nodejs.org/en/download/) version 16.14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
## Progress

## Generate a new site

Generate a new Docusaurus site using the **classic template**.

The classic template will automatically be added to your project after you run the command:

```bash
npm init docusaurus@latest my-website classic
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

## Start your site

Run the development server:

```bash
cd my-website
npm run start
```

The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
We went public with UniversalPython in March, 2023. We're looking for amazing maintainers and contributers, and wish to initiate a movement across the world to make programming languages and computer science education accessible to all.
4 changes: 2 additions & 2 deletions docs/tutorial-basics/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"label": "Tutorial - Basics",
"label": "Tutorial",
"position": 2,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Docusaurus concepts."
"description": "5 minutes to learn the most important UniversalPython concepts."
}
}
23 changes: 0 additions & 23 deletions docs/tutorial-basics/congratulations.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/tutorial-basics/create-a-blog-post.md

This file was deleted.

57 changes: 0 additions & 57 deletions docs/tutorial-basics/create-a-document.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/tutorial-basics/create-a-page.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/tutorial-basics/deploy-your-site.md

This file was deleted.

9 changes: 9 additions & 0 deletions docs/tutorial-basics/jupyter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
sidebar_position: 2
---

# From Jupyter Notebook

You can use UniversalPython directly in Jupyter notebook.

Follow the instructions in our Jupyter Notebook [kernel repo](https://github.com/UniversalPython/urdu_python_kernel).
Loading