You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project includes a specialized debugging tool for analyzing and troubleshooting DocC symbol graphs, particularly those generated from OpenAPI specifications.
69
+
70
+
### Debug Tool Features
71
+
72
+
- Analyze symbol graph structure and relationships
73
+
- Validate relationships between symbols
74
+
- Detect common issues like missing source/target symbols or invalid path hierarchies
75
+
- Debug OpenAPI-specific conversion issues
76
+
- Analyze HTTP endpoints and associated metadata
77
+
- Combine and analyze multiple symbol graph files
78
+
79
+
### Using the Debug Tool
80
+
81
+
```bash
82
+
# Basic analysis of a symbol graph
83
+
swift run symbol-graph-debug analyze registry.symbolgraph.json
84
+
85
+
# Debug OpenAPI-specific conversion issues
86
+
swift run symbol-graph-debug openapi-debug registry.symbolgraph.json
87
+
88
+
# Analyze a directory of symbol graphs
89
+
swift run symbol-graph-debug unified .build/symbolgraphs/ -o combined-analysis.json
90
+
```
91
+
92
+
For more information, see the [Symbol Graph Debug Tool README](Sources/SymbolGraphDebug/README.md).
93
+
64
94
## Viewing the Documentation
65
95
66
96
The `docs/` directory in this repository contains the pre-generated DocC documentation website output for the **Swift Package Registry API**, which was built using the `registry.symbolgraph.json` generated by this tool and the `RegistryAPI.docc` catalog.
0 commit comments