Skip to content

Commit

Permalink
Introducing: Article description (#99)
Browse files Browse the repository at this point in the history
Changes
---

The following change introduces:

- Default Article / Page description 
- Page-specific description

(The following is aimed at introducing a basic summary of the topic at
hand, to showcase to the user that has received the URL of the platform
chosen to improve user experience and attach the readers to the given
articles).

Note:
---

Please Use Squash Merge for the Merge upon review.

- This limits it to 1 commit instead of multiple, that is not necessary
to be shown.
  • Loading branch information
JDSherbert authored Jun 12, 2024
2 parents b3a25a8 + a2504c0 commit 09440c4
Show file tree
Hide file tree
Showing 73 changed files with 73 additions and 1 deletion.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: Programming Handbook
description: Programming Snippets tricks docs
description: An open-source platform for sharing and preserving programming knowledge. Discover code snippets, best practices, and resources, all continuously updated by a thriving community of developers. Join us to collaborate and enhance your coding skills in one comprehensive space.
theme: just-the-docs

url: https://just-the-docs.github.io
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/Algorithms/Algorithms.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Algorithms
description: An Article that explores algorithmic concepts, types, techniques and analysis of time complexity.
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/Concepts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Concepts
description: An article dicussing the concept of programming concepts with a definition, use cases and history. Where additional Sub-topics go into the topics of each concept in detail.
nav_order: 5
has_children: true
---
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/DevOps/DevOps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: DevOps
description: An article discussing the concept of DevOps and the utilization of platforms and environments in development.
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/ECS/ECS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: ECS
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/Inheritance/Inheritance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Inheritance
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/Memory/Memory.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Memory
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/OOP/OOP.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: OOP
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/Polymorphism/Polymorphism.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Polymorphism
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Concepts/SOLID/SOLID.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: SOLID
description: An article discussing the concept of SOLID, its principles, types and definitions. Example code provides an overview of the concept by utalizing a coffing making method.
nav_order: 1
parent: Concepts
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Engine/Engine.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Engine
description: An article discussing about the use cases of video game engines, history and definition.
nav_order: 4
has_children: true
---
Expand Down
1 change: 1 addition & 0 deletions docs/Engine/GameMakerStudio/GameMakerStudio.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: GameMakerStudio
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Engine
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Engine/Godot/Godot.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Godot
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Engine
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Engine/Unity/Unity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Unity
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Engine
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Engine/UnrealEngine/UnrealEngine.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Unreal Engine
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Engine
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/DirectX/DirectX.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: DirectX
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Framework
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/Flutter/Flutter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Flutter
description: An article showcasing Flutter, a robust development kit framework. In this comprehensive exploration, we delve into its capabilities, features, and practical applications, offering detailed descriptions and illustrative examples.
nav_order: 1
parent: Framework
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/Framework.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Framework
description: An article dicussing about Frameworks, an essential tool in software development with description, use cases and History.
nav_order: 3
has_children: true
---
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/JUCE/JUCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: JUCE
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Framework
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/NET/net.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: .NET
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Framework
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/OpenGL/OpenGL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: OpenGL
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Framework
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Framework/SFML/SFML.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: SFML
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Framework
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/AdobeDreamWeaver/AdobeDreamWeaver.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Adobe DreamWeaver
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: IDE
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/IDE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: IDE
description: An article about Integrated development environment (IDE) defining use cases, history and describtion.
nav_order: 2
has_children: true
---
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/MonoDevelop/MonoDevelop.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: MonoDevelop
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: IDE
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/NetBeans/NetBeans.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: NetBeans
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: IDE
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/Notepad++/Notepad++.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Notepad++
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: IDE
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/Rider/Rider.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Rider
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: IDE
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/VSCode/VSCode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: VSCode
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
parent: IDE
has_children: false
---
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/VisualStudio/ChangeProjectName.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Change Project Name
description: An article discussing methods to transfer github enterprise account repositires into personal github repositires.
nav_order: 1
parent: Visual Studio
grand_parent: IDE
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/VisualStudio/IncludeDLLs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Include DLLs
description: An article demonstrating the use cases of DLL linking within visual studio. A practical use when dealing with programming libraries and code organization.
nav_order: 2
parent: Visual Studio
grand_parent: IDE
Expand Down
1 change: 1 addition & 0 deletions docs/IDE/VisualStudio/VisualStudio.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Visual Studio
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: IDE
has_children: true
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C#/C#.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: C#
description: An article dicussing features, key releases and getting started topics about C# a modern, versatile, object-oriented programming language developed by Microsoft.
nav_order: 1
parent: Language
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/Addresses.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Addresses
description: An article dicussing about c++ memory addresses.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/C++.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: C++
description: An article dicussing features, key releases and getting started topics about C++ a modern, versatile, object-oriented programming language developed by Microsoft.
nav_order: 1
parent: Language
has_children: true
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/ConstantPointerToConstant.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Constant Pointers To Constants
description: An article dicussing about c++ Constant Pointers To Constants, its benefits and basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/ConstantPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Constant Pointers
description: An article dicussing about c++ constant pointers, its benefits and basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/Dereferencing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Dereferencing
description: An article dicussing about c++ Dereferencing, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/MemberPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Member Pointers
description: An article dicussing about c++ Member Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/MultilevelPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Multilevel Pointers
description: An article dicussing about c++ Multi-level Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/NullPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Null Pointers
description: An article dicussing about c++ Null Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/PointerToConstant.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Pointers To Constants
description: An article dicussing about c++ Pointers To Constants, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/Pointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Pointers
description: An article dicussing about c++ Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/RawPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Raw Pointers
description: An article dicussing about c++ Raw Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/References.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: References
description: An article dicussing about c++ References, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/SmartPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Smart Pointers
description: An article dicussing about c++ Smart Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C++/VoidPointers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Void Pointers
description: An article dicussing about c++ Void Pointers, with basic examples.
nav_order: 1
parent: C++
grand_parent: Language
Expand Down
1 change: 1 addition & 0 deletions docs/Language/C/C.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: C
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Language
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Language/CSS/CSS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: CSS
description: "Warning: The following page is currently under construction, find more about the details in future patches, or if you choose to add in the article see info on the bottom of the page."
nav_order: 1
parent: Language
has_children: false
Expand Down
1 change: 1 addition & 0 deletions docs/Language/Dart/Dart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Dart
description: An article dicussing about the programming language dart, with description and basic examples.
nav_order: 1
parent: Language
has_children: false
Expand Down
Loading

0 comments on commit 09440c4

Please sign in to comment.