Add "Relevant links" sections to various documentation files for improved navigation

wilfredinni · wilfredinni · commit d020bd888a09 · 2025-08-03T14:48:45.000-04:00
diff --git a/docs/cheatsheet/args-and-kwargs.md b/docs/cheatsheet/args-and-kwargs.md
@@ -71,3 +71,12 @@ Keywords are accessed through the `kwargs` variable:
 >>> some_function(key1='arg1', key2='arg2')
 # keywords: {'key1': 'arg1', 'key2': 'arg2'} as <class 'dict'>
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/functions">Functions</router-link>
+- <router-link to="/cheatsheet/lists-and-tuples">Lists and Tuples</router-link>
+- <router-link to="/cheatsheet/dictionaries">Python Dictionaries</router-link>
+- <router-link to="/blog/python-easy-args-kwargs">Python *args and **kwargs Made Easy</router-link>
+- <router-link to="/builtin/tuple">tuple()</router-link>
+- <router-link to="/builtin/dict">dict()</router-link>
diff --git a/docs/cheatsheet/basics.md b/docs/cheatsheet/basics.md
@@ -377,3 +377,14 @@ Or from a `string` to an `integer` or `float`:
 >>> float('3.14')
 # 3.14
 ```
+
+## Relevant Links
+
+- <router-link to="/blog/python-data-types">Python Data Types: A Visual Guide for Beginners</router-link>
+- <router-link to="/blog/python-comprehensions-step-by-step">Python Comprehensions Step-by-Step</router-link>
+- <router-link to="/cheatsheet/control-flow">Control Flow</router-link>
+- <router-link to="/cheatsheet/functions">Functions</router-link>
+- <router-link to="/cheatsheet/lists-and-tuples">Lists and Tuples</router-link>
+- <router-link to="/cheatsheet/dictionaries">Dictionaries</router-link>
+- <router-link to="/cheatsheet/sets">Sets</router-link>
+- <router-link to="/cheatsheet/string-formatting">String Formatting</router-link>
diff --git a/docs/cheatsheet/comprehensions.md b/docs/cheatsheet/comprehensions.md
@@ -118,3 +118,12 @@ A List comprehension can be generated from a dictionary:
 >>> ["{}:{}".format(k.upper(), v) for k, v in c.items()]
 ['NAME:Pooka', 'AGE:5']
 ```
+
+## Relevant links
+
+- <router-link to="/blog/python-comprehensions-step-by-step">Python Comprehensions: A step by step Introduction</router-link>
+- <router-link to="/cheatsheet/lists-and-tuples">Python Lists and Tuples</router-link>
+- <router-link to="/cheatsheet/sets">Python Sets</router-link>
+- <router-link to="/cheatsheet/dictionaries">Python Dictionaries</router-link>
+- <router-link to="/blog/python-sets-what-why-how">Python Sets: What, Why and How</router-link>
+- <router-link to="/blog/python-data-types">Python Data Types Blog Post</router-link>
diff --git a/docs/cheatsheet/context-manager.md b/docs/cheatsheet/context-manager.md
@@ -66,3 +66,11 @@ with ContextManager():
 #test
 #--exit--
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/reading-and-writing-files">Reading and Writing Files</router-link>
+- <router-link to="/cheatsheet/exception-handling">Exception Handling</router-link>
+- <router-link to="/cheatsheet/decorators">Decorators</router-link>
+- <router-link to="/blog/python-pathlib-essentials">10 Essential File System Operations Every Developer Should Know</router-link>
+- <router-link to="/builtin/open">open()</router-link>
diff --git a/docs/cheatsheet/control-flow.md b/docs/cheatsheet/control-flow.md
@@ -488,3 +488,13 @@ useful when a `break` condition can occur in the loop:
 # Type exit to exit: exit
 # You typed exit
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/basics">Basics</router-link>
+- <router-link to="/cheatsheet/functions">Functions</router-link>
+- <router-link to="/cheatsheet/exception-handling">Exception Handling</router-link>
+- <router-link to="/cheatsheet/lists-and-tuples">Lists and Tuples</router-link>
+- <router-link to="/cheatsheet/sets">Sets</router-link>
+- <router-link to="/cheatsheet/dictionaries">Dictionaries</router-link>
+- <router-link to="/cheatsheet/comprehensions">Comprehensions</router-link>
diff --git a/docs/cheatsheet/dataclasses.md b/docs/cheatsheet/dataclasses.md
@@ -75,3 +75,12 @@ It is mandatory to define the data type in dataclass. However, If you would rath
 ...    name: Any
 ...    value: Any = 42
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/oop-basics">OOP Basics</router-link>
+- <router-link to="/cheatsheet/decorators">Decorators</router-link>
+- <router-link to="/blog/python-data-types">Python Data Types Blog Post</router-link>
+- <router-link to="/builtin/object">object()</router-link>
+- <router-link to="/builtin/repr">repr()</router-link>
+- <router-link to="/builtin/type">type()</router-link>
diff --git a/docs/cheatsheet/debugging.md b/docs/cheatsheet/debugging.md
@@ -195,3 +195,8 @@ Instead of displaying the log messages to the screen, you can write them to a te
 >>> import logging
 >>> logging.basicConfig(filename='myProgramLog.txt', level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/exception-handling">Exception Handling</router-link>
+- <router-link to="/builtin/breakpoint">breakpoint()</router-link>
diff --git a/docs/cheatsheet/decorators.md b/docs/cheatsheet/decorators.md
@@ -180,6 +180,16 @@ say_hi("James")
   </base-disclaimer-content>
 </base-disclaimer>
 
+## Relevant links
+
+- <router-link to="/cheatsheet/functions">Functions</router-link>
+- <router-link to="/cheatsheet/args-and-kwargs">Args and Kwargs</router-link>
+- <router-link to="/blog/python-easy-args-kwargs">Python *args and **kwargs Made Easy</router-link>
+- <router-link to="/builtin/classmethod">classmethod()</router-link>
+- <router-link to="/builtin/staticmethod">staticmethod()</router-link>
+- <router-link to="/builtin/property">property()</router-link>
+- <router-link to="/builtin/callable">callable()</router-link>
+
 
 
 
diff --git a/docs/cheatsheet/dictionaries.md b/docs/cheatsheet/dictionaries.md
@@ -267,3 +267,15 @@ For Python 3.5+:
 >>> dict_c
 # {'a': 1, 'b': 3, 'c': 4}
 ```
+
+## Relevant links
+
+- <router-link to="/blog/python-data-types">Python Data Types Blog Post</router-link>
+- <router-link to="/blog/python-easy-args-kwargs">Python *args and **kwargs Made Easy</router-link>
+- <router-link to="/cheatsheet/comprehensions">Comprehensions</router-link>
+- <router-link to="/cheatsheet/args-and-kwargs">Args and Kwargs</router-link>
+- <router-link to="/blog/python-comprehensions-step-by-step">Python Comprehensions Step-by-Step</router-link>
+- <router-link to="/builtin/dict">dict()</router-link>
+- <router-link to="/builtin/len">len()</router-link>
+- <router-link to="/builtin/iter">iter()</router-link>
+- <router-link to="/builtin/zip">zip()</router-link>
diff --git a/docs/cheatsheet/exception-handling.md b/docs/cheatsheet/exception-handling.md
@@ -134,3 +134,10 @@ Handling a custom exception is the same as any other:
 ...
 # My custom exception was raised
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/control-flow">Control Flow</router-link>
+- <router-link to="/builtin/breakpoint">breakpoint()</router-link>
+- <router-link to="/builtin/isinstance">isinstance()</router-link>
+- <router-link to="/builtin/issubclass">issubclass()</router-link>
diff --git a/docs/cheatsheet/file-directory-path.md b/docs/cheatsheet/file-directory-path.md
@@ -342,3 +342,9 @@ The `Path` object has an `rglob()` method for recursively iterating over files a
 # C:\\delicious\\walnut\\waffles
 # C:\\delicious\\walnut\\waffles\\butter.txt
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/reading-and-writing-files">Reading and Writing Files</router-link>
+- <router-link to="/blog/python-pathlib-essentials">10 Essential File System Operations Every Developer Should Know</router-link>
+- <router-link to="/builtin/open">open()</router-link>
diff --git a/docs/cheatsheet/functions.md b/docs/cheatsheet/functions.md
@@ -174,3 +174,12 @@ Like regular nested functions, lambdas also work as lexical closures:
 >>> plus_5(4)
 # 9
 ```
+
+## Relevant links
+
+- <router-link to="/blog/python-easy-args-kwargs">*args and **kwargs explained</router-link>
+- <router-link to="/cheatsheet/args-and-kwargs">Args and Kwargs</router-link>
+- <router-link to="/cheatsheet/decorators">Decorators</router-link>
+- <router-link to="/cheatsheet/control-flow">Control Flow</router-link>
+- <router-link to="/cheatsheet/basics">Basics</router-link>
+- <router-link to="/builtin">Built-in Functions</router-link>
diff --git a/docs/cheatsheet/json-yaml.md b/docs/cheatsheet/json-yaml.md
@@ -67,3 +67,12 @@ Usage:
 >>> import anyconfig
 >>> conf1 = anyconfig.load("/path/to/foo/conf.d/a.yml")
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/reading-and-writing-files">Reading and Writing Files</router-link>
+- <router-link to="/cheatsheet/dictionaries">Python Dictionaries</router-link>
+- <router-link to="/modules/json-module">The json Module</router-link>
+- <router-link to="/blog/python-pathlib-essentials">10 Essential File System Operations Every Developer Should Know</router-link>
+- <router-link to="/builtin/open">open()</router-link>
+- <router-link to="/builtin/dict">dict()</router-link>
diff --git a/docs/cheatsheet/lists-and-tuples.md b/docs/cheatsheet/lists-and-tuples.md
@@ -392,3 +392,13 @@ The main way that tuples are different from lists is that tuples, like strings,
 >>> list('hello')
 # ['h', 'e', 'l', 'l', 'o']
 ```
+
+## Relevant links
+
+- <router-link to="/blog/python-data-types">Python Data Types: A Visual Guide for Beginners</router-link>
+- <router-link to="/blog/python-comprehensions-step-by-step">Python Comprehensions Step-by-Step</router-link>
+- <router-link to="/cheatsheet/comprehensions">Python Comprehensions</router-link>
+- <router-link to="/modules/itertools-module">The itertools Module</router-link>
+- <router-link to="/builtin/list">list()</router-link>
+- <router-link to="/builtin/tuple">tuple()</router-link>
+- <router-link to="/builtin/len">len()</router-link>
diff --git a/docs/cheatsheet/main.md b/docs/cheatsheet/main.md
@@ -38,3 +38,10 @@ For example, we are developing a script designed to be used as a module, we shou
 2. If you import this script as a module in another script, the **name** is set to the name of the script/module.
 3. Python files can act as either reusable modules, or as standalone programs.
 4. `if __name__ == "__main__":` is used to execute some code only if the file is run directly, and is not being imported.
+
+## Relevant links
+
+- <router-link to="/cheatsheet/functions">Functions</router-link>
+- <router-link to="/cheatsheet/setup-py">setup.py</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-1">Python projects with Poetry and VSCode. Part 1</router-link>
+- <router-link to="/builtin/import">import()</router-link>
diff --git a/docs/cheatsheet/manipulating-strings.md b/docs/cheatsheet/manipulating-strings.md
@@ -330,3 +330,13 @@ Replaces all occurences of a given substring with another substring. Can be opti
 >>> sentence.replace("apples", "oranges")
 # 'I like oranges, Apples are my favorite fruit'
 ```
+
+## Relevant links
+
+- <router-link to="/builtin/format">format()</router-link>
+- <router-link to="/builtin/len">len()</router-link>
+- <router-link to="/builtin/str">str()</router-link>
+- <router-link to="/builtin/repr">repr()</router-link>
+- <router-link to="/builtin/input">input()</router-link>
+- <router-link to="/cheatsheet/string-formatting">String Formatting</router-link>
+- <router-link to="/cheatsheet/regular-expressions">Regular Expressions</router-link>
diff --git a/docs/cheatsheet/oop-basics.md b/docs/cheatsheet/oop-basics.md
@@ -1,4 +1,4 @@
- ---
+---
 title: Python OOP Basics - Python Cheatsheet
 
 description: Object-Oriented Programming (OOP) is a programming paradigm that revolves around the concept of objects, which are instances of classes. OOP principles are fundamental concepts that guide the design and development of software in an object-oriented way. In Python, OOP is supported by the use of classes and objects. Here are some of the basic OOP principles in Python
@@ -214,3 +214,17 @@ for shape in shapes:
 
 These are some of the basic OOP principles in Python. This page is currently in progress and more
 detailed examples and explanations will be coming soon.
+
+## Relevant links
+
+- <router-link to="/cheatsheet/functions">Functions</router-link>
+- <router-link to="/cheatsheet/decorators">Decorators</router-link>
+- <router-link to="/cheatsheet/exception-handling">Exception Handling</router-link>
+- <router-link to="/cheatsheet/dataclasses">Dataclasses</router-link>
+- <router-link to="/builtin/object">object()</router-link>
+- <router-link to="/builtin/classmethod">classmethod()</router-link>
+- <router-link to="/builtin/staticmethod">staticmethod()</router-link>
+- <router-link to="/builtin/property">property()</router-link>
+- <router-link to="/builtin/isinstance">isinstance()</router-link>
+- <router-link to="/builtin/issubclass">issubclass()</router-link>
+- <router-link to="/builtin/super">super()</router-link>
diff --git a/docs/cheatsheet/reading-and-writing-files.md b/docs/cheatsheet/reading-and-writing-files.md
@@ -71,3 +71,11 @@ You can also iterate through the file line by line:
 # Hello world!
 # Bacon is not a vegetable.
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/file-directory-path">File and directory Paths</router-link>
+- <router-link to="/cheatsheet/json-yaml">Json and Yaml</router-link>
+- <router-link to="/blog/python-pathlib-essentials">10 Essential File System Operations Every Developer Should Know</router-link>
+- <router-link to="/builtin/open">open()</router-link>
+- <router-link to="/builtin/print">print()</router-link>
diff --git a/docs/cheatsheet/regular-expressions.md b/docs/cheatsheet/regular-expressions.md
@@ -391,3 +391,10 @@ phone_regex = re.compile(r'''(
     (\s*(ext|x|ext.)\s*\d{2,5})?  # extension
     )''', re.VERBOSE)
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/manipulating-strings">Manipulating Strings</router-link>
+- <router-link to="/cheatsheet/string-formatting">String Formatting</router-link>
+- <router-link to="/blog/python-data-types">Python Data Types Blog Post</router-link>
+- <router-link to="/builtin/compile">compile()</router-link>
diff --git a/docs/cheatsheet/sets.md b/docs/cheatsheet/sets.md
@@ -156,3 +156,10 @@ Both methods will remove an element from the set, but `remove()` will raise a `k
 >>> s1.symmetric_difference(s2)  # or 's1 ^ s2'
 # {1, 4}
 ```
+
+## Relevant links
+
+- <router-link to="/blog/python-data-types">Python Data Types Blog Post</router-link>
+- <router-link to="/blog/python-sets-what-why-how">Python Sets: What, Why and How</router-link>
+- <router-link to="/cheatsheet/dictionaries">Python Dictionaries</router-link>
+- <router-link to="/cheatsheet/lists-and-tuples">Python Lists and Tuples</router-link>
diff --git a/docs/cheatsheet/setup-py.md b/docs/cheatsheet/setup-py.md
@@ -56,3 +56,13 @@ setup(
 ```
 
 Find more information visit the [official documentation](http://docs.python.org/3.11/install/index.html).
+
+## Relevant links
+
+- <router-link to="/cheatsheet/virtual-environments">Virtual Environments</router-link>
+- <router-link to="/cheatsheet/file-directory-path">File and directory Paths</router-link>
+- <router-link to="/blog/python-uv-package-manager">UV: The Lightning-Fast Python Package Manager</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-1">Python projects with Poetry and VSCode. Part 1</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-2">Python projects with Poetry and VSCode. Part 2</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-3">Python projects with Poetry and VSCode. Part 3</router-link>
+- <router-link to="/builtin/import">import()</router-link>
diff --git a/docs/cheatsheet/string-formatting.md b/docs/cheatsheet/string-formatting.md
@@ -175,3 +175,13 @@ A simpler and less powerful mechanism, but it is recommended when handling strin
 >>> t.substitute(name=name)
 # 'Hey Elizabeth!'
 ```
+
+## Relevant links
+
+- <router-link to="/cheatsheet/manipulating-strings">Manipulating Strings</router-link>
+- <router-link to="/blog/python-data-types">Python Data Types Blog Post</router-link>
+- <router-link to="/builtin/format">format()</router-link>
+- <router-link to="/builtin/print">print()</router-link>
+- <router-link to="/builtin/str">str()</router-link>
+- <router-link to="/builtin/repr">repr()</router-link>
+- <router-link to="/builtin/ascii">ascii()</router-link>
diff --git a/docs/cheatsheet/virtual-environments.md b/docs/cheatsheet/virtual-environments.md
@@ -218,4 +218,11 @@ Usage:
 
 UV automatically manages virtual environments, Python versions, and dependencies with exceptional speed and convenience.
 
-For comprehensive information about UV's features and performance benefits, read our detailed guide: <router-link to="/blog/python-uv-package-manager">UV: The Lightning-Fast Python Package Manager</router-link>.
+## Relevant links
+
+- <router-link to="/cheatsheet/setup-py">setup.py</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-1">Python projects with Poetry and VSCode. Part 1</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-2">Python projects with Poetry and VSCode. Part 2</router-link>
+- <router-link to="/blog/python-projects-with-poetry-and-vscode-part-3">Python projects with Poetry and VSCode. Part 3</router-link>
+- <router-link to="/blog/python-uv-package-manager">UV: The Lightning-Fast Python Package Manager</router-link>
+- <router-link to="/builtin/import">import()</router-link>
