MeshWeaver.Documentation
3.0.0-rc7
This is a prerelease version of MeshWeaver.Documentation.
dotnet add package MeshWeaver.Documentation --version 3.0.0-rc7
NuGet\Install-Package MeshWeaver.Documentation -Version 3.0.0-rc7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MeshWeaver.Documentation" Version="3.0.0-rc7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MeshWeaver.Documentation" Version="3.0.0-rc7" />
<PackageReference Include="MeshWeaver.Documentation" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MeshWeaver.Documentation --version 3.0.0-rc7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MeshWeaver.Documentation, 3.0.0-rc7"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MeshWeaver.Documentation@3.0.0-rc7
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MeshWeaver.Documentation&version=3.0.0-rc7&prerelease
#tool nuget:?package=MeshWeaver.Documentation&version=3.0.0-rc7&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MeshWeaver.Documentation
Serves the MeshWeaver platform documentation as embedded markdown resources under the Doc/ namespace, automatically converting them to read-only MeshNodes with YAML front matter parsing.
Features
- Loads markdown files from embedded resources in the
Data/folder at startup - Parses YAML front matter for metadata: title, authors, tags, category, icon, abstract
- Registers a read-only
PartitionAccessPolicyso documentation cannot be modified - Grants all authenticated users read access via a public
AccessAssignment - Serves static content (icons, images) from the
Content/embedded resources - Covers Architecture, DataMesh, GUI, and AI Integration topics
Usage
// In MeshBuilder setup
builder.AddDocumentation();
This registers the DocumentationNodeProvider as a static node provider and creates a Doc partition visible in Global Settings. Documentation is then accessible at paths like Doc/Architecture/ActorModel.
Dependencies
MeshWeaver.Mesh.Contract--MeshNode,MeshBuilder, and static node provider interfacesMeshWeaver.Markdown--MarkdownContentparsingMeshWeaver.ContentCollections-- embedded resource content serving
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- MeshWeaver.ContentCollections (>= 3.0.0-rc7)
- MeshWeaver.Hosting (>= 3.0.0-rc7)
- MeshWeaver.Markdown (>= 3.0.0-rc7)
- MeshWeaver.Mesh.Contract (>= 3.0.0-rc7)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.