chore: scaffold ShellDocs monorepo — 6 projects, .slnx, CI, design docs - #1
Merged
Conversation
…ncluding command scaffolding, project files, and templates. Add CLI entry point with commands for initialization, creation, development, building, and previewing documentation. Introduce core services and markdown processing capabilities.
…ts for NavigationNode, MarkdownPipelineFactory, and StarterPageTemplate. Introduce project file for test project configuration and dependencies.
…, including architecture, design, and roadmap details. Introduce comprehensive descriptions of features, usage, and package structure to support developers in utilizing the framework.
…Directory.Build.props, and Directory.Packages.props. Introduce LICENSE file and solution structure for ShellDocs with project references for CLI, components, core, markdown, templates, and tests.
…t up continuous integration to build, test, and package ShellDocs CLI.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bootstraps
shellui-dev/shelldocs. Every project registered, build clean, tests green, CLI wired. Zero implementation — this branch is the runway that unblocks every branch after it.What ships
Root config
.gitignoreLICENSEREADME.mdglobal.json10.0.301withrollForward: latestFeatureDirectory.Build.propsTargetFramework=net10.0, nullable, package metadata (Authors, License, Repo URL),IsPackable=falsedefaultDirectory.Packages.propsshelldocs.slnx/src/and/tests/folders.github/workflows/ci.ymlDesign docs (
docs/)Three docs written to align the whole framework before we write any implementation:
DESIGN.mdROADMAP.md0.1.0-alpha→1.0.0ARCHITECTURE.md<DynamicComponent>rendering, static site genSix projects
ShellDocs.CoreNavigationNode.csscaffold. Blazor-agnostic — Markdig + YamlDotNet deps only.ShellDocs.MarkdownMarkdownPipelineFactory.csplaceholder that returns a working Markdig pipeline.ShellDocs.Components_Imports.razor+ServiceCollectionExtensions.cs(AddShellDocs()extension is stubbed but callable) +wwwroot/shelldocs.js(emptywindow.ShellDocsmonolith). ShellUI ref commented out until ShellUI publishes to NuGet — added infeat/components-shell.ShellDocs.CLI<PackAsTool>true</PackAsTool>,ToolCommandName=shelldocs) +Program.cswith all 5 subcommands wired via System.CommandLine beta5. Handlers are stubs; command tree is real.ShellDocs.TemplatesStarterPageTemplate.cs. Content-only, mirrors ShellUI.Templates pattern.ShellDocs.TestsScaffoldingTests.cs— 3 smoke tests covering each package's public surface.CLI logo
Same ANSI Shadow figlet ShellUI uses, so the family reads as one: