swift-nio

History

Cory Benfield a7c36a7654 Clean up and regression check the docs. (#2400 ) Motivation: Up until recently, it has not been possible to regression check our documentation. However, in recent releases of the DocC plugin it has become possible to make warnings into errors, making it possible for us to CI our docs. This patch adds support for doing that, and also cleans up our documentation so that it successfully passes the check. Along the way I accidentally wrote an `index.md` for `NIOCore` so I figure we may as well keep it. Modifications: - Structure the documentation for NIOCore - Fix up DocC issues - Add `check-docs.sh` script to check the docs cleanly build - Wire things up to our docker-compose scripts. Result: We can CI our docs. Co-authored-by: George Barnett <gbarnett@apple.com>	2023-04-11 09:05:22 +01:00
..
Docs.docc	Clean up and regression check the docs. (#2400 )	2023-04-11 09:05:22 +01:00
Exports.swift	Move NIO to NIOPosix, make NIO a shell. (#1936 )	2021-08-16 16:50:40 +01:00

Clean up and regression check the docs. (#2400 )

Motivation:

Up until recently, it has not been possible to regression check our
documentation. However, in recent releases of the DocC plugin it has
become possible to make warnings into errors, making it possible for us
to CI our docs.

This patch adds support for doing that, and also cleans up our
documentation so that it successfully passes the check.

Along the way I accidentally wrote an `index.md` for `NIOCore` so I
figure we may as well keep it.

Modifications:

- Structure the documentation for NIOCore
- Fix up DocC issues
- Add `check-docs.sh` script to check the docs cleanly build
- Wire things up to our docker-compose scripts.

Result:

We can CI our docs.

Co-authored-by: George Barnett <gbarnett@apple.com>

2023-04-11 09:05:22 +01:00

Docs.docc

Clean up and regression check the docs. (#2400 )

2023-04-11 09:05:22 +01:00

Exports.swift

Move NIO to NIOPosix, make NIO a shell. (#1936 )

2021-08-16 16:50:40 +01:00