-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Nest.js: Rework installation method & exception filter documentation #13525
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
This sounds reasonable to me! Thanks for extracting my comments into an actionable issue :D |
Next Steps1. Nest.js Quick Start guide:
Note: To help with the maintainability of these changes, I updated the Nest.js's quick start guide to no longer inherit content from getting-started-node. Quick Start guide content is now in docs/platforms/javascript/guides/nestjs/index.mdx -> see PR #13497 2. Installation Methods
I'm already working on 1) How do you think we should proceed with 2)? |
|
I agree with Charly
we can just create the nest specific version that links to QS (and doesn't show much more, if anything)
+1 -- we can either duplicate the pages for Nest or adjust the code snippets. No strong opinions. One more thing: I'd probably also slightly adjust the "How to Decide Which Instal. Method to use" section and mention NestJS. For example, add a subsection that reads something like:
|
Uh oh!
There was an error while loading. Please reload this page.
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:
a. @Lms24 suggests we could create a "NestJS Features -> Exception Filters" page
a. some code blocks are marked as being Javascript although they are Typescript
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!
The text was updated successfully, but these errors were encountered: