Skip to content

Commit 91a5ede

Browse files
azarovalexrnro
andauthored
Fix API documentation links in README.md (#3276)
Point API docs URLs to the latest stable version instead of the unstable main branch. ### Motivation: For most of developers this README.md is the main entry point when searching online or installing the library, so pointing them to API docs for the latest stable release makes more sense then the main branch, which may contain not-yet-released API or breaking changes. ### Modifications: This PR removes `main` branch name from API docs URLs, making them always point to the latest stable release instead of the main branch. ### Result: API docs URLs in README.md point to the latest stable release. Co-authored-by: Rick Newton-Rogers <[email protected]>
1 parent f5339fb commit 91a5ede

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ The core SwiftNIO repository will contain a few extremely important protocol imp
218218

219219
## Documentation
220220

221-
- [API documentation](https://swiftpackageindex.com/apple/swift-nio/main/documentation/nio)
221+
- [API documentation](https://swiftpackageindex.com/apple/swift-nio/documentation/nio)
222222

223223
## Example Usage
224224

@@ -346,26 +346,26 @@ swift package benchmark
346346

347347
For more information please refer to `swift package benchmark --help` or the [documentation of `package-benchmark`](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark).
348348

349-
[ch]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channelhandler
350-
[c]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channel
351-
[chc]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channelhandlercontext
352-
[ec]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioembedded/embeddedchannel
353-
[el]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloop
354-
[eel]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioembedded/embeddedeventloop
355-
[elg]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloopgroup
356-
[bb]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/bytebuffer
357-
[elf]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventloopfuture
358-
[elp]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/eventlooppromise
359-
[cp]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niocore/channelpipeline
360-
[sbootstrap]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/serverbootstrap
361-
[cbootstrap]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/clientbootstrap
362-
[dbootstrap]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/datagrambootstrap
363-
[mtelg]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/nioposix/multithreadedeventloopgroup
364-
[nioh1]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niohttp1
365-
[nioh2]: https://swiftpackageindex.com/apple/swift-nio-http2/main/documentation/niohttp2
366-
[niows]: https://swiftpackageindex.com/apple/swift-nio/main/documentation/niowebsocket
367-
[niossl]: https://swiftpackageindex.com/apple/swift-nio-ssl/main/documentation/niossl
368-
[niossh]: https://swiftpackageindex.com/apple/swift-nio-ssh/main/documentation/niossh
349+
[ch]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/channelhandler
350+
[c]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/channel
351+
[chc]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/channelhandlercontext
352+
[ec]: https://swiftpackageindex.com/apple/swift-nio/documentation/nioembedded/embeddedchannel
353+
[el]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/eventloop
354+
[eel]: https://swiftpackageindex.com/apple/swift-nio/documentation/nioembedded/embeddedeventloop
355+
[elg]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/eventloopgroup
356+
[bb]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/bytebuffer
357+
[elf]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/eventloopfuture
358+
[elp]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/eventlooppromise
359+
[cp]: https://swiftpackageindex.com/apple/swift-nio/documentation/niocore/channelpipeline
360+
[sbootstrap]: https://swiftpackageindex.com/apple/swift-nio/documentation/nioposix/serverbootstrap
361+
[cbootstrap]: https://swiftpackageindex.com/apple/swift-nio/documentation/nioposix/clientbootstrap
362+
[dbootstrap]: https://swiftpackageindex.com/apple/swift-nio/documentation/nioposix/datagrambootstrap
363+
[mtelg]: https://swiftpackageindex.com/apple/swift-nio/documentation/nioposix/multithreadedeventloopgroup
364+
[nioh1]: https://swiftpackageindex.com/apple/swift-nio/documentation/niohttp1
365+
[nioh2]: https://swiftpackageindex.com/apple/swift-nio-http2/documentation/niohttp2
366+
[niows]: https://swiftpackageindex.com/apple/swift-nio/documentation/niowebsocket
367+
[niossl]: https://swiftpackageindex.com/apple/swift-nio-ssl/documentation/niossl
368+
[niossh]: https://swiftpackageindex.com/apple/swift-nio-ssh/documentation/niossh
369369
[pthreads]: https://en.wikipedia.org/wiki/POSIX_Threads
370370
[kqueue]: https://en.wikipedia.org/wiki/Kqueue
371371
[epoll]: https://en.wikipedia.org/wiki/Epoll

0 commit comments

Comments
 (0)