Skip to content

Commit 5c34f25

Browse files
chore: Improve documentation
1 parent 547412c commit 5c34f25

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ export default defineConfig({
7474
{ text: 'CLI Parameters', link: '#cli-parameters' },
7575
{ text: 'Configuration file', link: '#configuration-file' },
7676
{ text: 'Debugging', link: '#debugging' },
77+
{ text: 'Removing', link: '#removing' },
7778
{ text: 'Development Process', link: '#development-process' },
7879
{ text: 'Observability Mode', link: '#observability-mode' },
7980
{ text: 'Monorepo', link: '#monorepo-setup' },
80-
{ text: 'Removing', link: '#removing' },
8181
],
8282
},
8383
{

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -167,21 +167,9 @@ Now, you have to press F5 or press Run -> Start Debugging, and you can set break
167167

168168
For other tools, please send documentation to include here. WebStorm instructions are especially needed.
169169

170-
## Development Process
171-
172-
Since you deploy code to a real AWS account, it's best to have a dedicated environment only for yourself. It could be your personal environment or an environment created for a feature. That is [common practice when developing serverless systems](https://theburningmonk.com/2019/09/why-you-should-use-temporary-stacks-when-you-do-serverless/). If that's not feasible due to organizational or technical reasons, use Observability Mode.
173-
174-
## Observability Mode
175-
176-
In Observability Mode, Lambda Live Debugger intercepts requests and sends them to your computer without waiting for a response. The Lambda continues as usual. The response from your machine is ignored. This mode can be used in the development, testing, or even, if you are adventurous, production environment. It samples requests every 3 seconds by default (configurable with an `interval` setting) to avoid overloading the system.
177-
178-
## Monorepo Setup
179-
180-
Set the `subfolder` parameter if your framework is in a subfolder.
181-
182170
## Removing
183171

184-
To remove Lambda Live Debugger from your AWS account
172+
When you no longer want to debug and want Lambda to execute the code deployed to the cloud, you need to remove the Lambda Live Debugger:
185173

186174
```
187175
lld -r
@@ -195,6 +183,18 @@ To also remove the Layer:
195183
lld -r=all
196184
```
197185

186+
## Development Process
187+
188+
Since you deploy code to a real AWS account, it's best to have a dedicated environment only for yourself. It could be your personal environment or an environment created for a feature. That is [common practice when developing serverless systems](https://theburningmonk.com/2019/09/why-you-should-use-temporary-stacks-when-you-do-serverless/). If that's not feasible due to organizational or technical reasons, use Observability Mode.
189+
190+
## Observability Mode
191+
192+
In Observability Mode, Lambda Live Debugger intercepts requests and sends them to your computer without waiting for a response. The Lambda continues as usual. The response from your machine is ignored. This mode can be used in the development, testing, or even, if you are adventurous, production environment. It samples requests every 3 seconds by default (configurable with an `interval` setting) to avoid overloading the system.
193+
194+
## Monorepo Setup
195+
196+
Set the `subfolder` parameter if your framework is in a subfolder.
197+
198198
## Frameworks
199199

200200
### AWS CDK v2

0 commit comments

Comments
 (0)