Skip to content

Commit f5ac84e

Browse files
SaadBazazSaadBazaz
committed
update docs
1 parent 606fa5e commit f5ac84e

24 files changed

+202
-536
lines changed

‎docs/contribute/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Contribute",
3+
"position": 5,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Want to help the UniversalPython movement? Here are some ways."
7+
}
8+
}

‎docs/contribute/core.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Improving UniversalPython
6+
7+
There are tonnes of interesting challenges which, when solved, can make UniversalPython easier to use and more resilient:
8+
- [ ] In-transpiler translation of sentences (e.g. translating strings)
9+
- [ ] How can we manage imports of packages, and the functions inside of them?
10+
- [ ] Supporting new and old versions of Python
11+
12+
Feel free to share more challenges in our [GitHub Discussions](https://github.com/UniversalPython/UniversalPython/discussions). We're ready for impact.

docs/tutorial-extras/img/docsVersionDropdown.png renamed to docs/contribute/img/docsVersionDropdown.png

File renamed without changes.

docs/tutorial-extras/img/localeDropdown.png renamed to docs/contribute/img/localeDropdown.png

File renamed without changes.

‎docs/contribute/improve-docs.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Improving the docs
6+
7+
We maintain our docs on GitHub, using Docusaurus. Some important tasks which are pending:
8+
- [ ] Translation of the documentation to different languages
9+
- [ ] Making it easier for people to suggest new words and add them to the dictionary
10+
- [ ] Computer science education, via a YouTube channel or blogs, in Native languages
11+
12+
Feel free to share more tasks in our [GitHub Discussions](https://github.com/UniversalPython/UniversalPython/discussions). We're ready for impact.

‎docs/contribute/translate.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Translate into your language
6+
7+
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.
8+
9+
The list of languages supported are visible [here](https://github.com/UniversalPython/UniversalPython/tree/%D9%85%D8%B1%DA%A9%D8%B2/urdupython/languages).
10+
11+
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 GitHub, or simply sharing it with us on email at info@grayhat.com.pk

‎docs/examples/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Examples",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn more by checking out code examples of UniversalPython which demonstrate its capabilities."
7+
}
8+
}

‎docs/examples/playground.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Playground
6+
7+
You can try out UniversalPython in our [online playground](https://universalpython.github.io). No installations required, it all runs in your browser!

‎docs/installation.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Installation
6+
7+
Get started with using UniversalPython.
8+
9+
## Before you begin...
10+
11+
You will require:
12+
- Some basic knowledge about Python
13+
- Python 3+ installed in your computer
14+
- Pip 3+ installed in your computer
15+
16+
> 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).
17+
18+
## Getting Started
19+
20+
Get started with UniversalPython by installing it from PyPI. Our package name is currently "urdupython" (changes to this soon!)
21+
22+
```
23+
pip install urdupython
24+
```
25+
26+
## Installing from source
27+
1. Download the [UniversalPython repo](https://github.com/UniversalPython/UniversalPython/) as a ZIP, or clone it via Git.
28+
2. Open the repo's folder in your Terminal.
29+
3. Run ```pip install -e .```
30+

‎docs/intro.md‎

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,18 @@
22
sidebar_position: 1
33
---
44

5-
# Tutorial Intro
5+
# Welcome
66

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

9-
## Getting Started
9+
## Our vision
1010

11-
Get started by **creating a new site**.
11+
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.
1212

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

15-
### What you'll need
15+
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.
1616

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

20-
## Generate a new site
21-
22-
Generate a new Docusaurus site using the **classic template**.
23-
24-
The classic template will automatically be added to your project after you run the command:
25-
26-
```bash
27-
npm init docusaurus@latest my-website classic
28-
```
29-
30-
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
31-
32-
The command also installs all necessary dependencies you need to run Docusaurus.
33-
34-
## Start your site
35-
36-
Run the development server:
37-
38-
```bash
39-
cd my-website
40-
npm run start
41-
```
42-
43-
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.
44-
45-
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/.
46-
47-
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
19+
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.

0 commit comments

Comments
 (0)