Skip to content

Commit d8297f6

Browse files
Add implementation steps to README.md documenting documentation hosting process
1 parent c37aae4 commit d8297f6

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,30 @@ The project uses GitHub Actions to automatically deploy documentation to GitHub
139139
## License
140140

141141
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.
166+
167+
### Step 2: OpenAPI to SymbolGraph Conversion
168+
// ... existing code ...

0 commit comments

Comments
 (0)