Merged
Conversation
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.
PR Summary: Migrate Documentation Site to Lunet
Overview
This PR replaces the previous DocFX-oriented documentation publishing flow with a Lunet-based site modeled after the TreeDataGrid documentation structure, but tailored to NativeMessageBox.
The result is:
site/documentation source treeWhy
The repository already had useful Markdown content, but the public docs pipeline was still centered on DocFX. TreeDataGrid uses a more structured Lunet setup with:
This PR brings the same documentation model here so the docs infrastructure is consistent across repositories.
Main Changes
1. Lunet site scaffold
Added a full
site/tree with:site/config.scribanfor site metadata, bundle setup, andapi.dotnetsite/menu.ymlfor top-level navigationsite/readme.mdas a custom homepagesite/articles/**with sectioned docs:site/.lunet/css/*for shared template CSS and project-specific overridessite/.lunet/layouts/*for improved API renderingsite/.lunet/includes/_builtins/bundle.sbn-htmlto support the customlitebundle reliablysite/images/logo.svgfor project branding2. Tailored NativeMessageBox content
The site content is not copied mechanically from TreeDataGrid. It is rewritten around this repository’s actual concerns:
NativeMessageBoxClientnative_message_box.h3. Local docs tooling
Added root-level scripts:
build-docs.shbuild-docs.ps1check-docs.shserve-docs.shserve-docs.ps1These are now location-independent and work even when invoked outside the repo root.
For compatibility,
docs/build-docs.shnow delegates to the new root Lunet build script.4. Tooling and ignore updates
docfxtolunet5. CI / publishing
Updated workflows so that:
ci.ymlvalidates the Lunet docs builddocs.ymlbuilds the Lunet site and deployssite/.lunet/build/wwwto GitHub Pages.github/workflows/README.mdreflects the current setup6. README updates
Updated the main
README.mddocumentation section so contributors know:Commit Breakdown
docs: add Lunet docs tooling scriptsdocs: add NativeMessageBox Lunet site contentci: validate and publish Lunet docs siteKey Files to Review
Docs infrastructure
.config/dotnet-tools.jsonbuild-docs.shbuild-docs.ps1check-docs.shserve-docs.shserve-docs.ps1docs/build-docs.shSite configuration and UX
site/config.scribansite/readme.mdsite/menu.ymlsite/.lunet/css/site-overrides.csssite/images/logo.svgContent structure
site/articles/getting-started/*site/articles/concepts/*site/articles/guides/*site/articles/platforms/*site/articles/advanced/*site/articles/reference/*CI / publishing
.github/workflows/ci.yml.github/workflows/docs.yml.github/workflows/README.mdREADME.mdValidation Performed
Executed successfully:
./build-docs.sh./check-docs.sh/Users/wieslawsoltes/GitHub/NativeMessageBox/build-docs.shfrom/tmpAlso verified:
Notes / Residuals
docs/docfxmaterial is still present in the repo, but it is no longer the active publishing path.