Skip to content

help

Show the published apps configuration and shortcuts doc URL for copy/paste.

Source code in src/personal_os_setup/tasks/system/help.py 
17
18
19
20
21
22
23
def show_apps_config_link() -> TaskResult:
    """Show the published apps configuration and shortcuts doc URL for copy/paste."""
    return TaskResult(
        ok=True,
        summary=f"{DOCS_SITE_URL}/apps/apps_configuration_and_shorcuts/",
        details="Open this link in a browser to view apps configuration and shortcuts.",
    )

Show the published documentation site URL for copy/paste.

Source code in src/personal_os_setup/tasks/system/help.py 
 8
 9
10
11
12
13
14
def show_documentation_link() -> TaskResult:
    """Show the published documentation site URL for copy/paste."""
    return TaskResult(
        ok=True,
        summary=DOCS_SITE_URL,
        details="Open this link in a browser to view the full documentation.",
    )

Show the published "Testing in a VM" doc URL for copy/paste.

Source code in src/personal_os_setup/tasks/system/help.py 
26
27
28
29
30
31
32
def show_vm_testing_link() -> TaskResult:
    """Show the published "Testing in a VM" doc URL for copy/paste."""
    return TaskResult(
        ok=True,
        summary=f"{DOCS_SITE_URL}/linux/CachyOS/#testing-this-project-in-a-vm",
        details="Open this link in a browser to view the make vm-* VM lab docs.",
    )