Skip to content

Commit a6000fa

Browse files
authored
Update README.md
1 parent 5ec8b26 commit a6000fa

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
<strong><em><code>unidoc</code></em></strong><br><small><code>0.2.8</code></small>
3+
<strong><em><code>unidoc</code></em></strong><br><small><code>0.3.0</code></small>
44

55
[![ci build status](https://github.com/kelvin13/swift-unidoc/actions/workflows/build.yml/badge.svg)](https://github.com/kelvin13/swift-unidoc/actions/workflows/build.yml)
66

@@ -70,6 +70,23 @@ Unidoc generates lightweight HTML documentation that uses CSS for the majority o
7070

7171
Unidoc symbol graphs include line-breaking markers computed by SwiftSyntax, which allows Unidoc to display long function signatures in a readable, line-wrapped format. This makes it much easier to scan long lists of symbols with complex signatures, such as the member list of SwiftSyntax’s [`AccessPathComponentSyntax`](https://swiftinit.org/docs/swift-syntax/swiftsyntax/accesspathcomponentsyntax).
7272

73+
74+
### 🚠 Per-symbol migration banners
75+
76+
The Unidoc server can now query successors for symbols in older (and prerelease) versions, and display a banner directing visitors to the symbol’s counterpart in the latest stable release of its package. This link is specific to the symbol, and comes with a corresponding `<link rel="canonical">` element and HTTP header.
77+
78+
Example: [`https://swiftinit.org/docs/swift-nio:2.57.0/niocore/eventloopgroup`](https://swiftinit.org/docs/swift-nio:2.57.0/niocore/eventloopgroup)
79+
80+
81+
### ️⛳️ Symbol disambiguation pages
82+
83+
Unidoc is able to serve symbol disambiguation pages under the [`300 Multiple Choice`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300) status code.
84+
85+
Although you should avoid creating ambiguous symbol links if possible, they are a natural occurrence as APIs evolve and overloads are added.
86+
87+
Example: [`https://swiftinit.org/docs/swift-certificates/x509/policyevaluationresult.failstomeetpolicy(reason:)`](https://swiftinit.org/docs/swift-certificates/x509/policyevaluationresult.failstomeetpolicy(reason:))
88+
89+
7390
### 🛸 Documentation coverage
7491

7592
Unidoc can compute documentation coverage on a per-package and per-module basis. You can view coverage levels as pie-chart visualizations on package and module pages; see [`swift-atomics`](https://github.com/apple/swift-atomics)’s [package page](https://swiftinit.org/docs/swift-atomics) for an example.

0 commit comments

Comments
 (0)