Skip to content

Commit b51ca6d

Browse files
chore: Documentation
1 parent 15a5746 commit b51ca6d

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

.vitepress/config.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ export default defineConfig({
6464
items: [
6565
{ text: 'Why?', link: '#why' },
6666
{ text: 'How It Works', link: '#how-it-works' },
67+
{
68+
text: 'Comparing to Alternatives',
69+
link: '#comaring-to-alternatives',
70+
},
6771
{ text: 'Help and Feedback', link: '#help-and-feedback' },
6872
],
6973
},

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,6 @@ It supports the following frameworks:
1313

1414
[![Video presentation of Lambda Live Debugger](https://img.youtube.com/vi/BrhybwyDM0I/0.jpg)](https://www.youtube.com/watch?v=BrhybwyDM0I)
1515

16-
It offers similar functionality to [SST](https://sst.dev/) and [Serverless Framework v4](https://www.serverless.com/blog/serverless-framework-v4-general-availability), with the following addition features:
17-
18-
- **Observability mode** – Enables debugging without impacting the system, so it can even be used in production.
19-
- **Quick toggle** – Debug mode can be turned off and back on almost instantly without requiring a redeploy like other solutions.
20-
- **Selective debugging** – You can debug only one or a few functions at a time, which is crucial for large and complex systems. Running many Lambdas simultaneously on a single machine can be confusing and can slow down your computer.
21-
2216
## Why?
2317

2418
Serverless is amazing and solves many issues with traditional systems. However, writing code for Lambda functions can be challenging. The cycle of writing, deploying, running, fixing, and redeploying is time-consuming and tedious. You could use tools to run Lambda locally or use unit/integration tests; those approaches often don't replicate the actual environment closely enough.
@@ -48,6 +42,14 @@ In case you do not want to debug all functions and add the Layer to them, you ca
4842

4943
The tool generates temporary files in the `.lldebugger` folder, which can be deleted after debugging. The wizard can add `.lldebugger` to `.gitignore` for you.
5044

45+
## Comaring to Alternatives
46+
47+
Lambda Live Debugger offers similar functionality to [SST](https://sst.dev/) and [Serverless Framework v4](https://www.serverless.com/blog/serverless-framework-v4-general-availability), with the following addition features:
48+
49+
- **Observability mode** – Enables debugging without impacting the system, so it can even be used in production.
50+
- **Quick toggle** – Debug mode can be turned off and back on almost instantly without requiring a redeploy like other solutions.
51+
- **Selective debugging** – You can debug only one or a few functions at a time, which is crucial for large and complex systems. Running many Lambdas simultaneously on a single machine can be confusing and can slow down your computer.
52+
5153
## Help and Feedback
5254

5355
**The tool has been thoroughly tested across many scenarios. It is flexible and can be adjusted to fit almost any setup. However, projects and TypeScript settings can be configured in numerous ways. If you need help or encounter a bug, please let me know by opening a [GitHub Issue](https://github.com/ServerlessLife/lambda-live-debugger/issues). This will not only help you but also others, because I can improve the tool and the documentation.**

0 commit comments

Comments
 (0)