Skip to content

docs: redesign site with modern pages and interactive config editor#419

Draft
tony19 wants to merge 6 commits into
gh-pagesfrom
claude/logback-android-site-editor-0f4p9i
Draft

docs: redesign site with modern pages and interactive config editor#419
tony19 wants to merge 6 commits into
gh-pagesfrom
claude/logback-android-site-editor-0f4p9i

Conversation

@tony19

@tony19 tony19 commented Jul 10, 2026

Copy link
Copy Markdown
Owner

Summary

Replaces the 2012-era single-page site with a modern, responsive, dependency-free static site, and adds an interactive logback.xml config 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 repo
  • about.html — project background, design goals, history (1.x → 3.x, JDK-specific artifacts table), architecture diagram, license
  • benefits.html — what you gain over android.util.Log, with a capability comparison table
  • docs.html — installation, configuration walkthrough, appender reference, special properties (${DATA_DIR}, ${LOG_DIR}, …), Android context setup, and links to the README/Javadoc/logback manual
  • editor.html — interactive config editor (see below)

Config editor

editor.html + assets/js/editor.js implement a client-side logback.xml builder:

  • Add/remove/rename appenders: Logcat, File, Rolling file, SQLite, Socket, Syslog, Email (SMTP) — each with its type-specific options (patterns, paths, rolling policy with maxHistory/maxFileSize, hosts/ports, etc.)
  • Add/remove loggers with per-package level and additivity control
  • Root level, debug="true", config-wide <property> definitions, and optional per-appender ThresholdFilter
  • Live syntax-highlighted XML preview, Copy/Download buttons, three quick-start presets, and localStorage persistence

Shared infrastructure

  • assets/css/site.css — single stylesheet with light/dark themes (system preference + manual toggle), responsive layout, no external fonts/CDNs
  • assets/js/site.js — theme toggle, mobile nav, code-block copy buttons
  • assets/img/favicon.svg

Preserved

Existing versioned Javadocs (doc/), changelog.html, faq.html, and old assets are untouched, so no existing deep links break.

Review feedback addressed

  • All wiki references removed site-wide: footers link to the README and Releases instead, the docs reference cards point to the README/issue tracker/Releases, and the editor's special-properties link points to the site's own docs section.

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, light theme

Landing page (dark)

Same page with the dark theme, which follows the system preference and can be toggled from the nav.

Landing page, dark theme

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.xml preview with Copy/Download/Reset.

Config editor default state

Config editor — configured (dark)

A rolling-file appender added alongside Logcat with a WARN threshold filter, plus a custom com.example.myapp logger at INFO. The XML preview updates live: ThresholdFilter, TimeBasedRollingPolicy with SizeAndTimeBasedFNATP, the <logger> element, and both appender-refs on root.

Config editor with rolling file appender and custom logger, dark theme

About page — project overview, design goals, version history table, and architecture diagram (full page)

About page

Benefits page — benefit cards and the capability comparison vs. android.util.Log (full page)

Benefits page

Docs page — installation, configuration, appender/property reference, and links to further material (full page)

Docs page

Verification

Served the site locally and drove it with headless Chromium (Playwright):

  • All five pages load with zero console/page errors; light and dark themes render correctly
  • Editor exercised end-to-end: adding/removing appenders and loggers, renaming an appender (refs update), threshold filters, properties, root level/debug, preset loading, reset, and localStorage persistence across reload
  • Generated XML validated as well-formed via DOMParser

🤖 Generated with Claude Code

https://claude.ai/code/session_01UB7UBorxG3PV8eC8iTjhGb

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
@tony19 tony19 changed the title Redesign site with modern pages and interactive config editor docs: redesign site with modern pages and interactive config editor Jul 10, 2026
claude added 5 commits July 10, 2026 02:44
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants