Skip to content

Streamline docs sdk authoring and end-user experience #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Streamline docs sdk authoring and end-user experience #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32fdd95
Create plan
baronfel Oct 23, 2025
b56ec08
first pass of stuff
baronfel Oct 23, 2025
37f6733
Package all the task dependencies completely per-TFM, making correct …
baronfel Oct 23, 2025
f21ce9e
Unify SDK build onto one package, simplify Task packaging
baronfel Oct 23, 2025
0006ee1
initial successful runs
baronfel Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/CloudNimble.DotNetDocs.Mintlify/MintlifyRenderer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public async Task RenderAsync(DocAssembly model)
ArgumentNullException.ThrowIfNull(model);

var apiOutputPath = Path.Combine(Context.DocumentationRootPath, Context.ApiReferencePath);
Console.WriteLine($"📝 Rendering documentation to: {apiOutputPath}");
// Console.WriteLine($"📝 Rendering documentation to: {apiOutputPath}");
Copy link
Author

@baronfel baronfel Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

direct console usage in internal libraries is very bad from the MSBuild perspective - you don't own stdout and should instead route all such logging through the MSBuild ILogger interfaces. Typically what this looks like for well-layered apps is using the M.E.L.ILogger internally, and making a small bridge adapter from M.E.L.ILogger to MSBuild's ILogger interface.


// Initialize DocsJsonManager if enabled (only on first call)
DocsJsonConfig? docsConfig = null;
Expand Down Expand Up @@ -1501,7 +1501,7 @@ private async Task GenerateNamespacePlaceholdersAsync(DocNamespace ns, string co
var namespacePath = Context.GetNamespaceFolderPath(ns.Name ?? "global");
var namespaceDir = Path.Combine(conceptualPath, namespacePath);

Console.WriteLine($"📝 Generating namespace placeholders for: {ns.Name} at {namespaceDir}");
// Console.WriteLine($"📝 Generating namespace placeholders for: {ns.Name} at {namespaceDir}");
Directory.CreateDirectory(namespaceDir);

// Generate individual placeholder files
Expand Down
54 changes: 0 additions & 54 deletions src/CloudNimble.DotNetDocs.Sdk.Tasks/CloudNimble.DotNetDocs.Sdk.Tasks.csproj
View file
Open in desktop

This file was deleted.

302 changes: 0 additions & 302 deletions src/CloudNimble.DotNetDocs.Sdk.Tasks/DiscoverDocumentedProjectsTask.cs
View file
Open in desktop

This file was deleted.

Loading