NOISSUE - Fix broken documentation links#94
Conversation
| "scripts": { | ||
| "build": "next build", | ||
| "dev": "next dev", | ||
| "dev": "NODE_OPTIONS='--max-old-space-size=3072' next dev", |
There was a problem hiding this comment.
what's the reason for this change?
There was a problem hiding this comment.
Node.js doesn't have a memory limit by default. it'll keep grabbing RAM until the machine runs out. That's exactly what happened to me. After about 22 minutes of running pnpm dev, the dev server had ballooned to 7.7GB of heap memory, crashed and took Brave down with it (the whole laptop was lagging).
This happens because Next.js dev mode compiles and caches every page you visit in memory and never clears it mid-session. Our docs files are on the larger side (some are 76–88KB of MDX) and those expand significantly once compiled. Over a long session it just stacks up.
The fix caps Node's memory at 3GB. Instead of silently eating all the RAM and hanging the machine, it'll now crash just the dev server at that limit. You restart it, carry on without any issues. 3GB is enough to work comfortably through a normal dev session.
|
@Musilah Please rebase. |
Signed-off-by: Musilah <nataleigh.nk@gmail.com>
Signed-off-by: Musilah <nataleigh.nk@gmail.com>
Signed-off-by: Musilah <nataleigh.nk@gmail.com>
Signed-off-by: Musilah <nataleigh.nk@gmail.com>
dborovcanin
left a comment
dborovcanin
left a comment
There was a problem hiding this comment.
Check if there are unused and duplicate links and remove export service references.
| [agent]: https://github.com/absmach/agent | ||
| [config]: https://github.com/absmach/magistrala/tree/main/provision#configuration | ||
| [env]: https://github.com/absmach/magistrala/blob/main/docker/.env | ||
| [mgui]: https://github.com/absmach/magistrala-ui-new |
There was a problem hiding this comment.
Remove UI (and other possibly unused links).
| [conftoml]: https://github.com/absmach/magistrala/blob/main/docker/addons/provision/configs/config.toml | ||
| [users]: https://github.com/absmach/magistrala/blob/main/users/README.md | ||
| [users]: https://magistrala.absmach.eu/docs/dev-guide/services/users/ | ||
| [exp]: https://github.com/absmach/export |
There was a problem hiding this comment.
Same here, export service needs some love before we return it to the docs. It will probably be replaced by agent.
| [http-adapter]: /docs/dev-guide/dev-tools/messaging#http | ||
| [mqtt-adapter]: /docs/dev-guide/dev-tools/messaging#mqtt | ||
| [coap-adapter]: /docs/dev-guide/dev-tools/messaging#coap | ||
| [ws-adapter]: /docs/dev-guide/dev-tools/messaging#websocket |
There was a problem hiding this comment.
We don't have adapters anymore, so rename. We also need to update the diagrams, but I'll need to do that.
3 participants
What type of PR is this?
This is a documentation update because it fixes broken internal links, replaces dead external documentation links, and refreshes outdated references across the docs.
What does this do?
Updates docs across
user-guide,dev-guide, and related app metadata so links resolve correctly and point to live destinations. This includes:/docs/...navigationreleaseNotesURL to a real existing pageWhich issue(s) does this PR fix/relate to?
N/A
Have you included tests for your changes?
Tested Manually
Did you document any new/modified features?
Notes