Skip to content

Commit b979d18

Browse files
committed
reordered sections
1 parent 771a849 commit b979d18

1 file changed

Lines changed: 32 additions & 34 deletions

File tree

README.md

Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -36,39 +36,6 @@ The original goal was to **analyse dependencies** in IaC workloads, but the modu
3636

3737
---
3838

39-
## Examples Index
40-
41-
Jump straight to focused, copy‑paste friendly examples for each major task. All examples assume the module is imported and use concise variable names.
42-
43-
### Graph Construction & Mutation
44-
* `New-Graph` – create an empty bidirectional graph (`docs/New-Graph.md`)
45-
* `New-AdjacencyGraph` – create an adjacency-list backed graph (`docs/New-AdjacencyGraph.md`)
46-
* `Add-Vertex` – add (or dedupe) vertices (`docs/Add-Vertex.md`)
47-
* `Add-Edge` – add directed edges with optional tag (`docs/Add-Edge.md`)
48-
* `Import-Graph` – load GraphML into a new graph (`docs/Import-Graph.md`)
49-
* `Export-Graph` – Graphviz / GraphML / MSAGL / Vega export (`docs/Export-Graph.md`)
50-
51-
### Graph Query & Analysis
52-
* `Get-GraphPath` – shortest path (Dijkstra) between two vertices (`docs/Get-GraphPath.md`)
53-
* `Test-GraphPath` – fast reachability boolean (`docs/Test-GraphPath.md`)
54-
* `Get-InEdge` / `Get-OutEdge` – incoming / outgoing edge enumeration (`docs/Get-InEdge.md`, `docs/Get-OutEdge.md`)
55-
* `Get-GraphDistanceVector` – root-based distance levels (`docs/Get-GraphDistanceVector.md`)
56-
57-
### Design Structure Matrix (DSM)
58-
* `New-DSM` – wrap a graph as a DSM (`docs/New-DSM.md`)
59-
* `Start-DSMClustering` – cluster / partition with SA or graph-based algorithms (`docs/Start-DSMClustering.md`)
60-
* `Start-DSMSequencing` – reorder to expose sources / cycles / sinks (`docs/Start-DSMSequencing.md`)
61-
* `Export-DSM` – text / Vega matrix export (`docs/Export-DSM.md`)
62-
63-
### Typical End-to-End Flows
64-
* Build → Query: New-Graph → Add-Vertex / Add-Edge → Get-GraphPath / Get-InEdge
65-
* Import → Analyse → Export: Import-Graph → Get-GraphDistanceVector → Export-Graph
66-
* Graph → DSM Insight: New-Graph → Add-* → New-DSM → Start-DSMClustering / Start-DSMSequencing → Export-DSM
67-
68-
> Tip: Each linked doc contains multiple scenarios; skim the first example for the minimal pattern, then look for advanced sections (weights, tagging, configs).
69-
70-
---
71-
7239
## Quick install
7340

7441
```powershell
@@ -237,4 +204,35 @@ Test-GraphPath -Graph $g -From A -To A # True (trivial)
237204

238205
Use `Get-GraphPath` when you need the actual path (edges) rather than just a boolean.
239206

240-
---
207+
---
208+
209+
## Examples Index
210+
211+
Jump straight to focused, copy‑paste friendly examples for each major task. All examples assume the module is imported and use concise variable names.
212+
213+
### Graph Construction & Mutation
214+
* `New-Graph` – create an empty bidirectional graph (`docs/New-Graph.md`)
215+
* `New-AdjacencyGraph` – create an adjacency-list backed graph (`docs/New-AdjacencyGraph.md`)
216+
* `Add-Vertex` – add (or dedupe) vertices (`docs/Add-Vertex.md`)
217+
* `Add-Edge` – add directed edges with optional tag (`docs/Add-Edge.md`)
218+
* `Import-Graph` – load GraphML into a new graph (`docs/Import-Graph.md`)
219+
* `Export-Graph` – Graphviz / GraphML / MSAGL / Vega export (`docs/Export-Graph.md`)
220+
221+
### Graph Query & Analysis
222+
* `Get-GraphPath` – shortest path (Dijkstra) between two vertices (`docs/Get-GraphPath.md`)
223+
* `Test-GraphPath` – fast reachability boolean (`docs/Test-GraphPath.md`)
224+
* `Get-InEdge` / `Get-OutEdge` – incoming / outgoing edge enumeration (`docs/Get-InEdge.md`, `docs/Get-OutEdge.md`)
225+
* `Get-GraphDistanceVector` – root-based distance levels (`docs/Get-GraphDistanceVector.md`)
226+
227+
### Design Structure Matrix (DSM)
228+
* `New-DSM` – wrap a graph as a DSM (`docs/New-DSM.md`)
229+
* `Start-DSMClustering` – cluster / partition with SA or graph-based algorithms (`docs/Start-DSMClustering.md`)
230+
* `Start-DSMSequencing` – reorder to expose sources / cycles / sinks (`docs/Start-DSMSequencing.md`)
231+
* `Export-DSM` – text / Vega matrix export (`docs/Export-DSM.md`)
232+
233+
### Typical End-to-End Flows
234+
* Build → Query: New-Graph → Add-Vertex / Add-Edge → Get-GraphPath / Get-InEdge
235+
* Import → Analyse → Export: Import-Graph → Get-GraphDistanceVector → Export-Graph
236+
* Graph → DSM Insight: New-Graph → Add-* → New-DSM → Start-DSMClustering / Start-DSMSequencing → Export-DSM
237+
238+
> Tip: Each linked doc contains multiple scenarios; skim the first example for the minimal pattern, then look for advanced sections (weights, tagging, configs).

0 commit comments

Comments
 (0)