Class DocumentationAddress

Namespace

MailFathom.Common

Assembly

MailFathom.Common.dll

Where the documentation for a version MailFathom reports is published.

public static class DocumentationAddress

Inheritance

object

DocumentationAddress

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The documentation site holds one directory per version it carries, so where a reader's own pages are is a function of the version in front of them and of nothing else. That is what lets a surface which already knows its version hand the address over without being told it: the container image labels it, the chart's notes print it, the administrative command reports the deployment's, and an MCP session carries it in the handshake. Nothing here is configurable for the same reason — an address an operator could edit could point a reader at pages describing a version other than the one they are running, which is the single thing this exists to prevent.

A prerelease resolves to the default branch's directory rather than to one of its own. A nightly is named after the release it will become, which the site does not publish until that release exists, and what a nightly actually carries is whatever main was the night it was built — which is what latest documents. The same reading covers a build nobody released.

The address is composed from the numbers a version parsed to rather than from the text it arrived as, because one caller reads that text off a deployment across the network and prints the result. A version this cannot read yields no address at all, and every caller says nothing rather than offering one that goes somewhere.

Methods

ForVersion(string?)

Reports where the documentation for a version is published.