Skip to content

Link to hosted swift-java documentation in README #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ktoso merged 1 commit into from
Oct 16, 2026
Merged

Link to hosted swift-java documentation in README #935

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,24 +220,20 @@ Please read the documentation of both performance testing tools, and note that r

## User Guide

More details about the project can be found in [docc](https://www.swift.org/documentation/docc/) documentation.
The swift-java project's [documentation](https://swiftpackageindex.com/swiftlang/swift-java/main/documentation/swiftjavadocumentation) is available on the Swift Package Index.

To view the rendered docc documentation you can use the docc preview command:
To preview the [DocC](https://www.swift.org/documentation/docc/) documentation, run:

```bash
# macOS
xcrun docc preview Sources/SwiftJavaDocumentation/Documentation.docc

# OR SwiftJava to view SwiftJava documentation:
# xcrun docc preview Sources/SwiftJava/Documentation.docc

# ========================================
# Starting Local Preview Server
# Address: http://localhost:8080/documentation/documentation
# ========================================
# Monitoring /Users/ktoso/code/swift-java/Sources/SwiftJavaDocumentation/Documentation.docc for changes...

# Linux (or any setup where docc is on your PATH)
docc preview Sources/SwiftJavaDocumentation/Documentation.docc
```

To preview the `SwiftJava` documentation instead, use `Sources/SwiftJava/Documentation.docc` as the path.

## Project Status

**This project is under active development. We welcome feedback about any issues you encounter.**
Expand Down
Loading