dev-dami / dev-dami/zario

docs: add copy-paste recipes for common Zario setups

Open
#89 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue help wanted
Dominant language
TypeScript
Stars
7
Forks
12
Avg merge
1d 11h
Merged PRs (30d)
5

Description

The core README is concise now, but contributors and new users would benefit from a small set of practical recipes that can be copied directly into real projects.

Goal

Add a docs/recipes.md page with short, tested examples for common Zario setups.

Suggested recipes

  • Basic Bun app logging.
  • Basic Node.js app logging.
  • Request-scoped child logger with a request ID.
  • JSON logging in production.
  • Redacting nested secrets.
  • Graceful shutdown with flush() / close().
  • File transport with rotation.
  • HTTP transport with retry/failure handling.

Acceptance criteria

  • Each recipe is self-contained and uses the current public API.
  • Keep each example small enough to understand without extra setup.
  • Add the new page to the README documentation table.
  • Where practical, add or extend tests so code snippets don't silently drift from the API.
  • Avoid duplicating full framework-specific adapter documentation.

This is intentionally documentation-focused and should be approachable for a first-time Zario contributor. Comment if you'd like to work on it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Create docs/recipes.md with small, self-contained examples for the listed Bun and Node.js logging setups. First read the current public API and the README documentation table; verify each recipe against the API and add or extend tests where practical. Done means all suggested recipes are documented, understandable without extra setup, linked from the README, and avoid duplicating framework adapter documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
bun, node.js, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.