Skip to content

Nest.js: Rework installation method & exception filter documentation #13525

Closed
@inventarSarah

Description

@inventarSarah

SDK

JavaScript SDK

Description

Let's rework the shared content on installing Sentry for Nest.js and Nest.js-specific error capturing (exception filters).

We have this longer content here: https://docs.sentry.io/platforms/javascript/guides/nestjs/install/commonjs/
which is also used in the quick start guide here: https://docs.sentry.io/platforms/javascript/guides/nestjs/

Goals:

  1. avoid structuring content underneath a "CommonJS" titled section when it's also valid for "ESM" and vice versa
  2. move content that is not needed for installation to a separate page
    a. @Lms24 suggests we could create a "NestJS Features -> Exception Filters" page
  3. show TS file tab instead of ESM/CJS for NestJS-CommmonJS (see comment here)
    a. some code blocks are marked as being Javascript although they are Typescript
  4. QS guide: update "Step 2: Configure" accordingly (this should only include the most important steps)
    a. consider creating a dedicated section "Step x: Capture Nest.js Errors" if needed

This will help make the documentation clearer and help users find the information they need more easily. Additionally, the quick start guide will benefit from the streamlined content.

Related: #13497

Suggested Solution

@Lms24 @chargome @mydea

Please comment if you can think of additional requirements or have other input!

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions