Skip to content

Commit

Permalink
Update readme & scripts for docs
Browse files Browse the repository at this point in the history
Update script to generate documentation from script comment.
Update table of content for redirect to Documentation
  • Loading branch information
UpperM committed Mar 22, 2020
1 parent 6ad089e commit 835676b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 14 deletions.
1 change: 0 additions & 1 deletion Generate-Desc.ps1 → Generate-Documentation.ps1
Expand Up @@ -6,7 +6,6 @@ $Folders = Get-ChildItem -Path "$RootFolder\Public"

foreach ($Folder in $Folders)
{

$TableContent = ""
$Content = ""
$DocumentationFile = "$PSScriptRoot\Documentation\$Folder.md"
Expand Down
12 changes: 12 additions & 0 deletions Generate-TableContent.ps1
@@ -0,0 +1,12 @@
Write-Output $PSScriptRoot

$RootFolder = "$PSScriptRoot\PSGuacamole"

$Folders = Get-ChildItem -Path "$RootFolder\Public"

foreach ($Folder in $Folders)
{
$Title = "# $Folder `n"
Write-Output " * [$Folder](Documentation/$Folder.md)"

}
26 changes: 13 additions & 13 deletions README.md
Expand Up @@ -9,25 +9,25 @@ This PowerShell module provides a series of cmdlets for interacting with the [Ap
<!-- TABLE OF CONTENTS -->
## Table of Contents
* [Getting Started](#getting-started)
* [Requirements](#requirements)
* [Requirements](Documentation/requirements)
* [Installation](#installation)
* [Examples](#examples)
* [Authentification](#authentification)
* [User Management](#user-management)
* [Connections Management](#connections-management)
* [Functions](#functions)
* [ConnectionGroups](#connectiongroups)
* [Connections](#connections)
* [History](#history)
* [Languages](#languages)
* [Patch](#patch)
* [Permissions](#permissions)
* [Schemas](#schemas)
* [SharingProfiles](#sharingprofiles)
* [Token](#token)
* [Tunnels](#tunnels)
* [UserGroups](#usergroups)
* [Users](#users)
* [APIConnection](Documentation/APIConnection.md)
* [ConnectionGroups](Documentation/ConnectionGroups.md)
* [Connections](Documentation/Connections.md)
* [History](Documentation/History.md)
* [Languages](Documentation/Languages.md)
* [Patch](Documentation/Patch.md)
* [Permissions](Documentation/Permissions.md)
* [Schemas](Documentation/Schemas.md)
* [SharingProfiles](Documentation/SharingProfiles.md)
* [Tunnels](Documentation/Tunnels.md)
* [UserGroups](Documentation/UserGroups.md)
* [Users](Documentation/Users.md)
* [Author](#author)

# Getting Started
Expand Down

0 comments on commit 835676b

Please sign in to comment.