Add DocFX documentation system and slim README#22
Merged
Conversation
…tures, mel-bridge
…k, pin docfx version
DJGosnell
added a commit
that referenced
this pull request
Apr 5, 2026
* Add DocFX infrastructure (config, template, TOC files) * Add DocFX landing page with feature grid * Add doc articles: getting-started, declaring-log-methods, log-levels, sinks * Add doc articles: formatting-and-output, scoped-context, advanced-features, mel-bridge * Add doc articles: operating-modes, performance, testing, configuration-reference * Add internals docs: architecture, diagnostics * Slim README from ~1400 to ~110 lines with doc site links * Add GitHub Actions workflow for docs deployment * Address review findings: add What Logsmith Is Not, fix benchmarks link, pin docfx version
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.
Summary
Set up a DocFX-based documentation system for Logsmith, mirroring the NexNet pattern (Dtronix/NexNet#72). Extracts all detailed content from the ~1400-line README into 12 focused doc articles and 2 internals pages, adds a landing page with feature grid, API reference config, and a GitHub Actions workflow for GitHub Pages deployment.
Reason for Change
The README contained all documentation inline — installation, modes, sinks, formatting, structured output, scoped context, sampling, dynamic levels, MEL bridge, abstraction mode, testing, configuration, architecture, and diagnostics. This made it difficult to navigate and maintain. Moving to a proper documentation site with DocFX provides searchable, structured documentation with auto-generated API reference.
Impact
docs.ymlworkflow builds DocFX (pinned v2.78.5) and deploys to GitHub Pages on push to master.Plan items implemented as specified
Deviations from plan implemented
performance.mdinstead ofconfiguration-reference.mdandtesting.md(better thematic fit).Gaps in original plan implemented
getting-started.mdduring review remediation.Migration Steps
Performance Considerations
No runtime impact — documentation only.
Security Considerations
docs.ymlpermissions are scoped tocontents: read,pages: write,id-token: write.Breaking Changes
#sinks,#log-levels-and-conditional-compilation) will break — content now in doc articles.