Skip to content

Commit c35af5f

Browse files
authored
feat(develop): Clean up contexts page structure (#13206)
The h3 for the examples kind of messed up the sidebar hierarchy, making it harder to parse.
1 parent d44f7d2 commit c35af5f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

develop-docs/sdk/data-model/event-payloads/contexts.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ related to the current user and the environment. For example, the device or
88
application version. Its canonical name is `contexts`.
99

1010
The `contexts` type can be used to define arbitrary contextual data on the
11-
event. It accepts an object of key/value pairs. The key is the alias of the
11+
event. It accepts an object of key/value pairs. The key is the "alias" of the
1212
context and can be freely chosen. However, as per policy, it should match the
1313
type of the context unless there are two values for a type. You can omit `type`
1414
if the key name is the type.
@@ -273,7 +273,7 @@ To summarize:
273273

274274
: _Optional_. Typically provides the full name, full version, and release alias. This maps to `PRETTY_NAME` in [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#PRETTY_NAME=) (examples: `Ubuntu 22.04.4 LTS`, `Raspian GNU/Linux 10 (buster)`).
275275

276-
### Example OS Context
276+
**Example OS Context**
277277

278278
The OS Context for the 3 major OSs should look like this:
279279

@@ -468,7 +468,7 @@ Examples: `"Apple Metal"` or `"Direct3D11"`
468468

469469
: _Optional_. Are geometry shaders available on the device?
470470

471-
### Example GPU Context
471+
**Example GPU Context**
472472

473473
```json
474474
{
@@ -496,7 +496,7 @@ The `type` and default key is `"state"`.
496496

497497
: **Required**. Object with two keys: _Optional_ `type` for naming the state library (e.g.: Redux, MobX, Vuex) and **Required** `value` that holds the state object.
498498

499-
### Example State Context
499+
**Example State Context**
500500

501501
```json
502502
{
@@ -598,7 +598,7 @@ The `type` and default key is `"cloud_resource"`.
598598

599599
- Example: `t4g.medium`
600600

601-
### Example Cloud Resource Context
601+
**Example Cloud Resource Context**
602602

603603
The following example illustrates the contexts part of the <Link to="/sdk/data-model/event-payloads/">event payload</Link> and omits other attributes for simplicity.
604604

@@ -720,7 +720,7 @@ The `route` currently supports the following predefined fields if it's a map:
720720

721721
If the route is set to a string (e.g. `"route": "foo"`), it will be normalized into a map (e.g. `"route": {"name": "foo"}`) server-side.
722722

723-
### Example Trace Context
723+
**Example Trace Context**
724724

725725
```json
726726
{
@@ -766,7 +766,7 @@ envelope endpoint.
766766

767767
: **Required**. The replay_id associated with the event.
768768

769-
### Example Replay Context
769+
**Example Replay Context**
770770

771771
```json
772772
{
@@ -792,7 +792,7 @@ This is mostly set on transactions in a web server environment where one transac
792792

793793
- Example: `200`
794794

795-
### Example Response Context
795+
**Example Response Context**
796796

797797
```json
798798
{
@@ -822,7 +822,7 @@ The required field is `package` which should contain the package or framework wh
822822

823823
- Example: `true`
824824

825-
### Example Response Context
825+
**Example Response Context**
826826

827827
```json
828828
{
@@ -852,7 +852,7 @@ The feature flag context contains information about the flags evaluated prior to
852852
- Example: `false`
853853

854854

855-
### Example Feature Flag Context
855+
**Example Feature Flag Context**
856856

857857
```json
858858
{

0 commit comments

Comments
 (0)