Skip to content

docs(readme): give JSON sidecar schema its own linkable section#270

Open
cameroncooke wants to merge 2 commits into
mainfrom
cameroncooke/eme-1191-give-the-json-sidecar-schema-its-own-linkable-section-in-the
Open

docs(readme): give JSON sidecar schema its own linkable section#270
cameroncooke wants to merge 2 commits into
mainfrom
cameroncooke/eme-1191-give-the-json-sidecar-schema-its-own-linkable-section-in-the

Conversation

@cameroncooke

Copy link
Copy Markdown
Contributor

The JSON sidecar field table, default context keys, and custom-context notes were buried inside § "1. Export the snapshots from your test run", nested under the TEST_RUNNER_SNAPSHOTS_EXPORT_DIR env-var docs. The nearest shareable anchor was the env-var section, which is orthogonal to the data format.

This PR extracts that content into a dedicated ### JSON sidecar schema section (parallel to the existing ### Snapshot modifiers section) so it has its own stable anchor (#json-sidecar-schema) and can be linked to directly.

Changes:

  • Moved the sidecar field table and context notes out of the env-var prose into a new ### JSON sidecar schema heading between ### Environment variables and ### 2. Upload to Sentry
  • Added an inline link from the .json bullet in the env-var section to the new anchor
  • No content was added or removed — only reorganised

Fixes EME-1191


View Session in Sentry

Co-Authored-By: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
@linear-code

linear-code Bot commented Jun 12, 2026

Copy link
Copy Markdown

EME-1191

@cameroncooke cameroncooke marked this pull request as ready for review June 12, 2026 10:06
Co-Authored-By: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
@cameroncooke cameroncooke requested a review from mtopo27 June 12, 2026 10:11
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.

1 participant