📝 add example-first documentation paths

This commit is contained in:
Nanaloveyuki
2026-07-17 16:24:06 +08:00
parent c6962fe71a
commit 4e2ef69b11
14 changed files with 480 additions and 66 deletions
+14 -16
View File
@@ -4,31 +4,29 @@ layout: home
hero:
name: BitLogger
text: Structured logging for MoonBit
tagline: API reference, examples, and release notes for BitLogger.
tagline: Start with a runnable logging flow, then extend it with precise API reference.
actions:
- theme: brand
text: Open API Reference
link: /api/
text: Start Examples
link: /examples/
- theme: alt
text: Read Release Notes
link: /changes/
text: Extend A Logger
link: /extend/
- theme: alt
text: Mooncake Package
link: https://mooncakes.io/docs/Nanaloveyuki/BitLogger
features:
- title: Structured logging
details: Levels, targets, message fields, and configurable text or JSON output.
- title: Sync and async paths
details: API reference covers both the main package and the async package surface.
- title: Config and runtime helpers
details: Browse builders, presets, file helpers, queue helpers, and verification notes quickly.
- title: Examples first
details: Follow complete console, file, config, and async flows before looking up individual symbols.
- title: Extend deliberately
details: Add queues, custom sink graphs, formatting, and target-specific behavior only when the base flow needs them.
- title: API as reference
details: Use the one-symbol-per-page API reference for exact signatures, contracts, and edge cases.
---
## Start Here
<HomeDocHub />
- Use [API Reference](./api/index.md) when you want the canonical one-file-per-public-API docs.
- Use [Release Notes](./changes/index.md) when you want version-scoped changes and publish-facing summaries.
- Use [Chinese README](https://github.com/Nanaloveyuki/BitLogger/blob/main/README.md) or [English README](./README-en.md) when you want a shorter project overview first.
1. Read [Examples](./examples/index.md) for an end-to-end path from installation to a running logger.
2. Read [Extend](./extend/index.md) when the base console flow needs queueing, custom routing, formatting, files, or target-aware behavior.
3. Use [API Reference](./api/index.md) for exact contracts and [Release Notes](./changes/index.md) for version history.