Skip to main content

​
Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: System.Object

​
Syntax

CloudNimble.DotNetDocs.Core.DocumentationReference

​
Summary

Represents a reference to external documentation to be combined into a documentation collection.

​
Remarks

This class encapsulates information needed to copy documentation files from a referenced project and integrate its navigation structure into a collection portal. Similar to MSBuild’s ProjectReference, but for documentation outputs.

​
Constructors

​
.ctor

Initializes a new instance of the DocumentationReference class.

​
Syntax

public DocumentationReference()

​
.ctor

Initializes a new instance of the DocumentationReference class with a project path.

​
Syntax

public DocumentationReference(string projectPath)

​
Parameters

NameTypeDescription
projectPathstringThe path to the .docsproj file being referenced.

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
DestinationPath

Gets or sets the path to the destination folder within the collection’s documentation root.

​
Syntax

public string DestinationPath { get; set; }

​
Property Value

Type: string The relative path where referenced documentation will be copied.

​
Examples

For a microservice named “auth-service”, this might be “services/auth”.

​
DocumentationRoot

Gets or sets the root directory containing the referenced documentation outputs.

​
Syntax

public string DocumentationRoot { get; set; }

​
Property Value

Type: string The absolute path to the documentation root of the referenced project.

​
Examples

C:\repos\auth-service\docs

​
DocumentationType

Gets or sets the documentation type of the referenced project.

​
Syntax

public CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; set; }

​
Property Value

Type: CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType The documentation format (Mintlify, DocFX, MkDocs, Jekyll, Hugo, or Generic).

​
Remarks

This determines which file patterns to copy and whether navigation combining is supported.

​
IntegrationType

Gets or sets the integration type for Mintlify navigation.

​
Syntax

public string IntegrationType { get; set; }

​
Property Value

Type: string Either “Tabs” or “Products” for Mintlify navigation structure.

​
Remarks

Only applicable when DocumentationType is “Mintlify”. Determines whether the referenced documentation appears in the top-level tabs or in the products section.

​
Name

Gets or sets the display name for this documentation reference in navigation.

​
Syntax

public string Name { get; set; }

​
Property Value

Type: string? The name to display for this documentation in tabs, products, or other navigation structures.

​
Remarks

When specified, this name is used instead of deriving the name from the project or other metadata. Useful for providing user-friendly names in navigation elements. Gets or sets the path to the navigation configuration file for the referenced documentation.

​
Syntax

public string NavigationFilePath { get; set; }

​
Property Value

Type: string The absolute path to the navigation file (e.g., docs.json for Mintlify).

​
Examples

C:\repos\auth-service\docs\docs.json

​
ProjectPath

Gets or sets the path to the .docsproj file being referenced.

​
Syntax

public string ProjectPath { get; set; }

​
Property Value

Type: string The absolute path to the documentation project file.

​
Examples

C:\repos\auth-service\docs\AuthService.docsproj

​
Methods

​
Equals Inherited Virtual

Inherited from object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?