Repository navigation
docs: Added deployment scenarios - #364
Conversation
Signed-off-by: Ilya Boyandin <[email protected]>
Signed-off-by: Ilya Boyandin <[email protected]>
Signed-off-by: Ilya Boyandin <[email protected]>
📝 WalkthroughWalkthroughThis PR introduces comprehensive deployment scenario documentation for SQLRooms and integrates it into the site navigation. A new docs/deployment-scenarios.md file outlines five deployment models with platform options, while README.md and docs/overview.md are updated to reference this guidance. The site configuration adds a sidebar entry for the new page. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/deployment-scenarios.md`:
- Line 91: Update the Query PWA example link that currently uses "tree/HEAD" so
it matches the rest of the document by using "tree/main" instead; locate the
link text "[Query PWA
example](https://github.com/sqlrooms/examples/tree/HEAD/query-pwa)" and replace
"HEAD" with "main" to make the URL "[Query PWA
example](https://github.com/sqlrooms/examples/tree/main/query-pwa)".
- Line 109: Replace the inconsistent internal link URL
"/case-studies.html#foursquare-spatial-desktop" (anchor text "Foursquare Spatial
Desktop case study") with the extension-less path
"/case-studies#foursquare-spatial-desktop" to match the other internal links'
format; update the link target in the markdown so it uses
"/case-studies#foursquare-spatial-desktop" instead of including ".html".
🧹 Nitpick comments (1)
README.md (1)
36-36: LGTM — new links follow existing README convention.The new Deployment Scenarios references are consistent with the existing link style and placement.
One minor note: all README links use
http://rather thanhttps://. This is a pre-existing pattern across the file, so not something to block this PR, but worth addressing in a follow-up.Also applies to: 58-59
| Examples and references: | ||
|
|
||
| - [Offline Use](https://sqlrooms.org/offline-use) | ||
| - [Query PWA example](https://github.com/sqlrooms/examples/tree/HEAD/query-pwa) |
There was a problem hiding this comment.
Inconsistent Git ref in link: HEAD vs main.
Line 61 uses tree/main for the sync example link, but line 91 uses tree/HEAD for the query-pwa example. Use main for consistency with the rest of the document.
Proposed fix
-- [Query PWA example](https://github.com/sqlrooms/examples/tree/HEAD/query-pwa)
+- [Query PWA example](https://github.com/sqlrooms/examples/tree/main/query-pwa)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Query PWA example](https://github.com/sqlrooms/examples/tree/HEAD/query-pwa) | |
| - [Query PWA example](https://github.com/sqlrooms/examples/tree/main/query-pwa) |
🤖 Prompt for AI Agents
In `@docs/deployment-scenarios.md` at line 91, Update the Query PWA example link
that currently uses "tree/HEAD" so it matches the rest of the document by using
"tree/main" instead; locate the link text "[Query PWA
example](https://github.com/sqlrooms/examples/tree/HEAD/query-pwa)" and replace
"HEAD" with "main" to make the URL "[Query PWA
example](https://github.com/sqlrooms/examples/tree/main/query-pwa)".
|
|
||
| Reference: | ||
|
|
||
| - [Foursquare Spatial Desktop case study](/case-studies.html#foursquare-spatial-desktop) |
There was a problem hiding this comment.
Inconsistent internal link format: .html extension used here but not elsewhere.
Other internal links in this file (e.g., lines 23–24, 42) use extension-less paths like /examples#.... This one uses /case-studies.html. Consider dropping the .html for consistency.
Proposed fix
-- [Foursquare Spatial Desktop case study](/case-studies.html#foursquare-spatial-desktop)
+- [Foursquare Spatial Desktop case study](/case-studies#foursquare-spatial-desktop)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Foursquare Spatial Desktop case study](/case-studies.html#foursquare-spatial-desktop) | |
| - [Foursquare Spatial Desktop case study](/case-studies#foursquare-spatial-desktop) |
🤖 Prompt for AI Agents
In `@docs/deployment-scenarios.md` at line 109, Replace the inconsistent internal
link URL "/case-studies.html#foursquare-spatial-desktop" (anchor text
"Foursquare Spatial Desktop case study") with the extension-less path
"/case-studies#foursquare-spatial-desktop" to match the other internal links'
format; update the link target in the markdown so it uses
"/case-studies#foursquare-spatial-desktop" instead of including ".html".
Summary by CodeRabbit