From 81d838a1e0a4151f37013ced40fa7709a3dfb58c Mon Sep 17 00:00:00 2001 From: Roy Date: Sat, 24 May 2025 19:43:18 +0300 Subject: [PATCH 1/2] Add documentation: 01-table-of-contents with technology READMEs --- Content/table-of-contents | 1 + 1 file changed, 1 insertion(+) create mode 160000 Content/table-of-contents diff --git a/Content/table-of-contents b/Content/table-of-contents new file mode 160000 index 0000000..32ac935 --- /dev/null +++ b/Content/table-of-contents @@ -0,0 +1 @@ +Subproject commit 32ac935aa7f3cdfcf4528d18c7e7c179a5efa0ad From e7089046db8bc019a2933a6cd6990b4d4674555e Mon Sep 17 00:00:00 2001 From: Roy Date: Sat, 24 May 2025 21:38:50 +0300 Subject: [PATCH 2/2] Fix submodule issue: re-add documentation folder as regular files --- Content/table-of-contents | 1 - .../01-table-of-contents/README.md | 17 +++++++ .../01-table-of-contents/css/README.md | 43 ++++++++++++++++++ .../01-table-of-contents/docker/README.md | 37 +++++++++++++++ .../01-table-of-contents/git/README.md | 38 ++++++++++++++++ .../01-table-of-contents/html/README.md | 43 ++++++++++++++++++ .../01-table-of-contents/javascript/README.md | 39 ++++++++++++++++ .../01-table-of-contents/nodejs/README.md | 45 +++++++++++++++++++ .../01-table-of-contents/python/README.md | 38 ++++++++++++++++ .../01-table-of-contents/react/README.md | 38 ++++++++++++++++ .../restful-apis/README.md | 39 ++++++++++++++++ .../01-table-of-contents/sql/README.md | 37 +++++++++++++++ .../01-table-of-contents/technologies.md | 31 +++++++++++++ 13 files changed, 445 insertions(+), 1 deletion(-) delete mode 160000 Content/table-of-contents create mode 100644 Content/table-of-contents/01-table-of-contents/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/css/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/docker/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/git/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/html/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/javascript/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/nodejs/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/python/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/react/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/restful-apis/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/sql/README.md create mode 100644 Content/table-of-contents/01-table-of-contents/technologies.md diff --git a/Content/table-of-contents b/Content/table-of-contents deleted file mode 160000 index 32ac935..0000000 --- a/Content/table-of-contents +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 32ac935aa7f3cdfcf4528d18c7e7c179a5efa0ad diff --git a/Content/table-of-contents/01-table-of-contents/README.md b/Content/table-of-contents/01-table-of-contents/README.md new file mode 100644 index 0000000..1deb592 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/README.md @@ -0,0 +1,17 @@ +# Overview of the Table of Contents Project + +This project aims to create a structured table of contents for various technologies, providing a clear and concise overview of each technology's purpose and application. The goal is to enhance the documentation of the project, making it easier for contributors and users to navigate through the available resources. + +## Purpose + +The primary purpose of this table of contents is to: + +- Organize existing content related to different technologies. +- Provide brief descriptions of each technology to help users understand their relevance and use cases. +- Serve as a reference point for contributors looking to add or improve documentation within the project. + +## How to Use + +1. **Explore the Technologies**: Navigate to the `technologies.md` file to view the structured table of contents, which lists various technologies along with their descriptions. +2. **Contribute**: If you have knowledge of additional technologies or improvements to existing descriptions, feel free to contribute by editing the `technologies.md` file. +3. **Documentation**: Refer to this README for guidance on the purpose and structure of the table of contents project. \ No newline at end of file diff --git a/Content/table-of-contents/01-table-of-contents/css/README.md b/Content/table-of-contents/01-table-of-contents/css/README.md new file mode 100644 index 0000000..4048a8b --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/css/README.md @@ -0,0 +1,43 @@ +# CSS + +![CSS Logo](https://upload.wikimedia.org/wikipedia/commons/d/d5/CSS3_logo_and_wordmark.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +CSS (Cascading Style Sheets) is a stylesheet language used to describe the presentation of a document written in HTML. + +## Key Features +- Controls layout, colors, and fonts +- Enables responsive design +- Supports animations and transitions +- Separates content from presentation + +## Usage +CSS is used for: +- Styling web pages +- Creating responsive layouts +- Animating elements + +## Examples +```css +body { + background-color: #f0f0f0; + color: #333; +} +h1 { + color: #007acc; +} +``` + +## Resources +- [MDN Web Docs - CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) +- [W3Schools CSS Tutorial](https://www.w3schools.com/css/) +- [CSS-Tricks](https://css-tricks.com/) diff --git a/Content/table-of-contents/01-table-of-contents/docker/README.md b/Content/table-of-contents/01-table-of-contents/docker/README.md new file mode 100644 index 0000000..5bd7afd --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/docker/README.md @@ -0,0 +1,37 @@ +# Docker + +![Docker Logo](https://upload.wikimedia.org/wikipedia/commons/4/4e/Docker_%28container_engine%29_logo.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +Docker lets you package apps and their dependencies into containers. It makes deployment easy and consistent. + +## Key Features +- Container technology +- Portable and scalable +- Fast deployment +- Big ecosystem + +## Usage +- Packaging apps +- Running isolated environments +- CI/CD pipelines + +## Examples +```bash +docker build -t myapp . +docker run -p 8080:80 myapp +``` + +## Resources +- [Docker Official Site](https://www.docker.com/) +- [Docker Docs](https://docs.docker.com/) +- [Docker Hub](https://hub.docker.com/) diff --git a/Content/table-of-contents/01-table-of-contents/git/README.md b/Content/table-of-contents/01-table-of-contents/git/README.md new file mode 100644 index 0000000..7033bac --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/git/README.md @@ -0,0 +1,38 @@ +# Git + +![Git Logo](https://upload.wikimedia.org/wikipedia/commons/3/3f/Git_icon.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +Git is a version control system that helps you track code changes, work with others, and manage project history. + +## Key Features +- Distributed system +- Branching and merging +- Fast and efficient +- Used everywhere + +## Usage +- Source code management +- Team collaboration +- Open source projects + +## Examples +```bash +git init +git add . +git commit -m "Initial commit" +``` + +## Resources +- [Git Official Site](https://git-scm.com/) +- [Atlassian Git Tutorial](https://www.atlassian.com/git/tutorials) +- [GitHub Learning Lab](https://lab.github.com/) diff --git a/Content/table-of-contents/01-table-of-contents/html/README.md b/Content/table-of-contents/01-table-of-contents/html/README.md new file mode 100644 index 0000000..5243fd1 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/html/README.md @@ -0,0 +1,43 @@ +# HTML + +![HTML Logo](https://upload.wikimedia.org/wikipedia/commons/6/61/HTML5_logo_and_wordmark.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +HTML is the standard markup language for building web pages. It gives structure and meaning to your content. + +## Key Features +- Defines web page structure +- Works with CSS and JS +- Supported by all browsers + +## Usage +- Creating web pages +- Embedding images and videos +- Making forms + +## Examples +```html + + + + My First HTML Page + + +

Hello, World!

+ + +``` + +## Resources +- [MDN HTML Guide](https://developer.mozilla.org/en-US/docs/Web/HTML) +- [W3Schools HTML](https://www.w3schools.com/html/) +- [HTML.com](https://html.com/) diff --git a/Content/table-of-contents/01-table-of-contents/javascript/README.md b/Content/table-of-contents/01-table-of-contents/javascript/README.md new file mode 100644 index 0000000..135d994 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/javascript/README.md @@ -0,0 +1,39 @@ +# JavaScript + +![JavaScript Logo](https://upload.wikimedia.org/wikipedia/commons/6/6a/JavaScript-logo.png) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +JavaScript is a versatile programming language used for web development, apps, and more. It lets you build interactive and dynamic websites. + +## Key Features +- Runs in all browsers +- Supports multiple programming styles +- Huge ecosystem +- Used for both frontend and backend + +## Usage +- Making web pages interactive +- Building web and mobile apps +- Server-side development (Node.js) + +## Examples +```javascript +function add(a, b) { + return a + b; +} +console.log(add(2, 3)); // 5 +``` + +## Resources +- [MDN JavaScript Guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript) +- [JavaScript.com](https://www.javascript.com/) +- [ECMAScript Spec](https://tc39.es/ecma262/) diff --git a/Content/table-of-contents/01-table-of-contents/nodejs/README.md b/Content/table-of-contents/01-table-of-contents/nodejs/README.md new file mode 100644 index 0000000..a69b8f6 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/nodejs/README.md @@ -0,0 +1,45 @@ +# Node.js + +![Node.js Logo](https://upload.wikimedia.org/wikipedia/commons/d/d9/Node.js_logo.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +Node.js lets you run JavaScript on the server. It’s great for building fast, scalable apps and APIs. + +## Key Features +- Asynchronous and event-driven +- Fast with V8 engine +- Huge npm ecosystem +- Cross-platform + +## Usage +- Web servers and APIs +- Real-time apps (chat, games) +- Command-line tools + +## Examples +```javascript +// Simple HTTP server with Node.js +const http = require('http'); +const server = http.createServer((req, res) => { + res.statusCode = 200; + res.setHeader('Content-Type', 'text/plain'); + res.end('Hello, World!'); +}); +server.listen(3000, () => { + console.log('Server running at http://localhost:3000/'); +}); +``` + +## Resources +- [Node.js Official Site](https://nodejs.org/) +- [MDN Node.js Guide](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Node_server_without_framework) +- [W3Schools Node.js](https://www.w3schools.com/nodejs/) diff --git a/Content/table-of-contents/01-table-of-contents/python/README.md b/Content/table-of-contents/01-table-of-contents/python/README.md new file mode 100644 index 0000000..64b1d17 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/python/README.md @@ -0,0 +1,38 @@ +# Python + +![Python Logo](https://upload.wikimedia.org/wikipedia/commons/c/c3/Python-logo-notext.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +Python is a high-level, easy-to-read language used for web development, data, automation, and more. It’s known for being beginner-friendly and super flexible. + +## Key Features +- Simple, readable syntax +- Tons of libraries +- Great for many types of projects +- Big, helpful community + +## Usage +- Web apps (Django, Flask) +- Data science and AI +- Automation scripts + +## Examples +```python +def add(a, b): + return a + b +print(add(2, 3)) # 5 +``` + +## Resources +- [Python.org](https://www.python.org/) +- [Real Python](https://realpython.com/) +- [W3Schools Python](https://www.w3schools.com/python/) diff --git a/Content/table-of-contents/01-table-of-contents/react/README.md b/Content/table-of-contents/01-table-of-contents/react/README.md new file mode 100644 index 0000000..69d2333 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/react/README.md @@ -0,0 +1,38 @@ +# React + +![React Logo](https://upload.wikimedia.org/wikipedia/commons/a/a7/React-icon.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +React is a JavaScript library for building user interfaces, especially single-page apps. It’s all about reusable components. + +## Key Features +- Component-based +- Fast updates with Virtual DOM +- Big ecosystem +- Works with hooks and state + +## Usage +- Interactive web apps +- Reusable UI parts +- Mobile apps (React Native) + +## Examples +```jsx +function HelloWorld() { + return

Hello, World!

; +} +``` + +## Resources +- [React Official Site](https://react.dev/) +- [MDN React Guide](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/React_getting_started) +- [W3Schools React](https://www.w3schools.com/react/) diff --git a/Content/table-of-contents/01-table-of-contents/restful-apis/README.md b/Content/table-of-contents/01-table-of-contents/restful-apis/README.md new file mode 100644 index 0000000..6dc76b4 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/restful-apis/README.md @@ -0,0 +1,39 @@ +# RESTful APIs + +![REST API Logo](https://upload.wikimedia.org/wikipedia/commons/6/6f/RestApi.svg) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +RESTful APIs are a way for different systems to talk to each other over HTTP. They use standard methods like GET, POST, PUT, and DELETE. + +## Key Features +- Stateless +- Uses HTTP methods +- Resource-based +- Super common in web dev + +## Usage +- Web and mobile backends +- Connecting systems +- Exposing data and services + +## Examples +```http +GET /api/users +POST /api/users +PUT /api/users/1 +DELETE /api/users/1 +``` + +## Resources +- [REST API Tutorial](https://restfulapi.net/) +- [MDN REST Guide](https://developer.mozilla.org/en-US/docs/Glossary/REST) +- [Postman Learning Center](https://learning.postman.com/docs/getting-started/introduction/) diff --git a/Content/table-of-contents/01-table-of-contents/sql/README.md b/Content/table-of-contents/01-table-of-contents/sql/README.md new file mode 100644 index 0000000..3ef116b --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/sql/README.md @@ -0,0 +1,37 @@ +# SQL + +![SQL Logo](https://upload.wikimedia.org/wikipedia/commons/8/87/Sql_data_base_with_logo.png) + +## Table of Contents +1. [Introduction](#introduction) +2. [Key Features](#key-features) +3. [Usage](#usage) +4. [Examples](#examples) +5. [Resources](#resources) + +--- + +## Introduction +SQL is a language for managing and working with data in relational databases. It’s used everywhere data lives. + +## Key Features +- Query and update data +- Supports transactions +- Used in all major databases +- Declarative syntax + +## Usage +- Querying databases +- Inserting, updating, deleting data +- Database admin + +## Examples +```sql +SELECT * FROM users; +INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com'); +``` + +## Resources +- [W3Schools SQL](https://www.w3schools.com/sql/) +- [SQLBolt](https://sqlbolt.com/) +- [Mode SQL Tutorial](https://mode.com/sql-tutorial/) diff --git a/Content/table-of-contents/01-table-of-contents/technologies.md b/Content/table-of-contents/01-table-of-contents/technologies.md new file mode 100644 index 0000000..c69cdb8 --- /dev/null +++ b/Content/table-of-contents/01-table-of-contents/technologies.md @@ -0,0 +1,31 @@ +# Technologies Table of Contents + +## 1. [JavaScript](./javascript/README.md) +A versatile programming language primarily used for web development, enabling interactive web pages and dynamic content. + +## 2. [Python](./python/README.md) +A high-level programming language known for its readability and versatility, widely used in web development, data analysis, artificial intelligence, and more. + +## 3. [HTML](./html/README.md) +The standard markup language for creating web pages, providing the structure and content of a webpage. + +## 4. [CSS](./css/README.md) +A stylesheet language used to describe the presentation of a document written in HTML, allowing for the design and layout of web pages. + +## 5. [React](./react/README.md) +A JavaScript library for building user interfaces, particularly single-page applications, by creating reusable UI components. + +## 6. [Node.js](./nodejs/README.md) +A JavaScript runtime built on Chrome's V8 engine, allowing developers to execute JavaScript on the server side, enabling full-stack development. + +## 7. [Git](./git/README.md) +A version control system that allows developers to track changes in code, collaborate with others, and manage project versions efficiently. + +## 8. [Docker](./docker/README.md) +A platform that enables developers to automate the deployment of applications inside lightweight, portable containers, ensuring consistency across environments. + +## 9. [SQL](./sql/README.md) +A domain-specific language used for managing and manipulating relational databases, allowing for data querying, insertion, updating, and deletion. + +## 10. [RESTful APIs](./restful-apis/README.md) +Architectural style for designing networked applications, allowing different systems to communicate over HTTP using standard methods like GET, POST, PUT, and DELETE. \ No newline at end of file