docs: redesign site with modern pages and interactive config editor#419
Draft
tony19 wants to merge 6 commits into
Draft
docs: redesign site with modern pages and interactive config editor#419tony19 wants to merge 6 commits into
tony19 wants to merge 6 commits into
Conversation
Replaces the 2012-era single-page site with a modern, responsive, dependency-free static site: - index.html: new landing page (hero, feature grid, quick start) - about.html: project background, design goals, history, architecture - benefits.html: advantages over android.util.Log, comparison table - docs.html: installation, configuration, appender/property reference - editor.html + assets/js/editor.js: interactive logback.xml builder with add/remove appenders (logcat, file, rolling, SQLite, socket, syslog, SMTP) and loggers, threshold filters, properties, presets, live highlighted XML preview, copy/download, and localStorage persistence - assets/: shared stylesheet (light/dark theme), site JS, favicon Existing Javadocs (doc/), legacy pages, and old assets are preserved. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb
The images stay referenced from the PR description via the previous commit's SHA; they don't belong in the deployed gh-pages content. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb
Footer links now point to the README and Releases; the docs page's reference cards link to the README, issue tracker, and releases; the editor's special-properties link points to the site's own docs section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb
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
Replaces the 2012-era single-page site with a modern, responsive, dependency-free static site, and adds an interactive
logback.xmlconfig editor.New pages
index.html— landing page: hero with version/API/license badges, Gradle snippet, "Why logback-android?" feature grid, 3-step quick start, and CTAs to the docs, editor, and GitHub repoabout.html— project background, design goals, history (1.x → 3.x, JDK-specific artifacts table), architecture diagram, licensebenefits.html— what you gain overandroid.util.Log, with a capability comparison tabledocs.html— installation, configuration walkthrough, appender reference, special properties (${DATA_DIR},${LOG_DIR}, …), Android context setup, and links to the README/Javadoc/logback manualeditor.html— interactive config editor (see below)Config editor
editor.html+assets/js/editor.jsimplement a client-sidelogback.xmlbuilder:maxHistory/maxFileSize, hosts/ports, etc.)debug="true", config-wide<property>definitions, and optional per-appenderThresholdFilterShared infrastructure
assets/css/site.css— single stylesheet with light/dark themes (system preference + manual toggle), responsive layout, no external fonts/CDNsassets/js/site.js— theme toggle, mobile nav, code-block copy buttonsassets/img/favicon.svgPreserved
Existing versioned Javadocs (
doc/),changelog.html,faq.html, and old assets are untouched, so no existing deep links break.Review feedback addressed
Screenshots
(Images are referenced from a pinned commit on this branch and were removed from the site tree in a follow-up commit, so they won't ship to the deployed site.)
Landing page (light)
Hero with release/API/license badges, Gradle dependency snippet with a hover copy button, and the feature grid below the fold.
Landing page (dark)
Same page with the dark theme, which follows the system preference and can be toggled from the nav.
Config editor — default state (light)
Fresh editor showing the minimal Logcat preset: configuration panel (root level, debug flag, properties), the Logcat appender's options, and the live syntax-highlighted
logback.xmlpreview with Copy/Download/Reset.Config editor — configured (dark)
A rolling-file appender added alongside Logcat with a
WARNthreshold filter, plus a customcom.example.myapplogger atINFO. The XML preview updates live:ThresholdFilter,TimeBasedRollingPolicywithSizeAndTimeBasedFNATP, the<logger>element, and bothappender-refs on root.About page — project overview, design goals, version history table, and architecture diagram (full page)
Benefits page — benefit cards and the capability comparison vs. android.util.Log (full page)
Docs page — installation, configuration, appender/property reference, and links to further material (full page)
Verification
Served the site locally and drove it with headless Chromium (Playwright):
DOMParser🤖 Generated with Claude Code
https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb