Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

docs: Add crash report architecture and implementation #39

Merged
merged 10 commits into from
Jun 20, 2024

Conversation

marknguyen1302
Copy link
Contributor

@marknguyen1302 marknguyen1302 commented Jun 18, 2024

Describe Your Changes

  • Add crash report architecture
  • Add crash report implementation
  • Add crash report schema

Fixes Issues

  • Closes #
  • Closes #

Self Checklist

  • Added relevant comments, esp in complex areas
  • Updated docs (for bug fixes / features)
  • Created issues for follow-up changes or refactoring needed

Copy link

github-actions bot commented Jun 18, 2024

Preview URL: https://31e4124c.cortex-docs.pages.dev

@irfanpena
Copy link
Contributor

@marknguyen1302 Hi Mark, thank you for this. I can help revamp and reformat this doc into a proper one that you can review later on. Also may ask you questions for content clarity

- Show all crash reports:
- `cortex telemetry --type crash`

## Type of Telemetry
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Types

- Show all crash reports:
- `cortex telemetry --type crash`

## Type of Telemetry
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move this section first, and rename it to Telemetry Collected.

Copy link
Contributor

@freelerobot freelerobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe @irfanpena can help to structure these docs to be a bit more explanatory. Otherwise, lgtm

Copy link
Contributor

@freelerobot freelerobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great job

@irfanpena irfanpena merged commit 9d12bfd into main Jun 20, 2024
1 check passed
@urmauur urmauur deleted the feat/add-crash-report-docs branch July 5, 2024 06:05
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants