Skip to content

1.0.1

Choose a tag to compare

@tyrsson tyrsson released this 10 Oct 06:11
· 2 commits to 1.0.x since this release
Immutable release. Only release title and notes can be modified.
2fbb181

Documentation release. No code changes.

Documentation

  • Adds docs/v1, the version 1 guide:
    • index.md: overview and how the middleware applies configuration.
    • getting-started.md: requirements, installation, ConfigProvider registration, debug flag, and pipeline wiring.
    • configuration.md: the full configuration reference. The debug switch, the enable key and its constants, the pass-through rule for the remaining Tracy\Debugger keys with a property table, the shipped defaults and how each merges, per-panel requirements, and both routes to database profiling.
  • Reduces the README to badges, requirements, a four step quick start, and the panel table, linking to the guide for the rest. 91 lines out, 23 in.

The guide documents two behaviours that are easy to get wrong:

  • keysToHide appends rather than replaces, so application entries add to the shipped password, pass, and secret defaults rather than displacing them.
  • Debugger::Development is the boolean false and Debugger::Production is true, so enable(true) selects production. The guide recommends the constants.

What's Changed

  • docs: add the v1 guide and a README quick start by @tyrsson in #46

Full Changelog: 1.0.0...1.0.1