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
Copy file name to clipboardExpand all lines: README.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -139,3 +139,30 @@ The project uses GitHub Actions to automatically deploy documentation to GitHub
139
139
## License
140
140
141
141
This project is licensed under the MIT License - see the LICENSE file for details.
142
+
143
+
## Implementation
144
+
145
+
### Step 1: Documentation Hosting
146
+
The first step in showcasing this project involved hosting the DocC-generated documentation for a User API at [https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/). This was achieved through the following process:
147
+
148
+
1.**Generate SymbolGraph File**:
149
+
```bash
150
+
swift run openapi-to-symbolgraph test/sample-api.json
151
+
```
152
+
This command converts the OpenAPI specification into a SymbolGraph file that DocC can understand.
153
+
154
+
2.**Convert to HTML Documentation**:
155
+
```bash
156
+
docc convert symbolgraph.json --output-path docs
157
+
```
158
+
This generates the interactive HTML documentation using DocC.
159
+
160
+
3.**Deploy to GitHub Pages**:
161
+
- The `docs` folder is deployed to GitHub Pages using the `/docs` source
162
+
- A landing page (`index.html`) is added to the root, providing easy navigation to the documentation
163
+
- The documentation is accessible at [https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/)
164
+
165
+
This implementation demonstrates the basic workflow of converting OpenAPI specifications to DocC documentation and making it accessible through GitHub Pages.
0 commit comments