Skip to content

Commit 157cd90

Browse files
Update main README.md to include Symbol Graph Debug Tool information
1 parent 0906950 commit 157cd90

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ The project is organized into several modules:
1717
- `Sources/OpenAPItoSymbolGraph` - Main implementation with submodules:
1818
- `Mapping` - Mappers between OpenAPI and SymbolGraph
1919
- `Utils/DocC` - DocC integration utilities
20+
- `Sources/SymbolGraphDebug` - Debugging tools for symbol graphs (see [Symbol Graph Debug Tool](#symbol-graph-debug-tool))
2021

2122
## Key Features
2223

2324
- Convert OpenAPI 3.1.0 specifications to DocC compatible format
2425
- Generate API documentation
2526
- Provide a consistent documentation experience for Swift developers
2627
- Support for documenting endpoints, schemas, parameters, and more
28+
- Debug and analyze symbol graphs for troubleshooting
2729

2830
## Getting Started
2931

@@ -61,6 +63,34 @@ Or manually with DocC:
6163
xcrun docc convert YourAPI.docc --fallback-display-name YourAPI --fallback-bundle-identifier com.example.YourAPI --fallback-bundle-version 1.0.0 --additional-symbol-graph-dir ./ --output-path ./docs
6264
```
6365

66+
## Symbol Graph Debug Tool
67+
68+
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+
6494
## Viewing the Documentation
6595

6696
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

Comments
 (0)