add: add new documentation, link with pypi and npm version of natural…#38
Merged
Conversation
…sql also add in about the principal contrubutor of the typescript version
📝 WalkthroughWalkthroughThe pull request removes the Nginx reverse proxy configuration and updates multiple client-side pages with UI enhancements, including new documentation sections, styling adjustments, and informational callouts about the playground database and external project usage. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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.
🧹 Nitpick comments (3)
app/client/src/pages/Chat.tsx (1)
52-69: Duplicate playground-tables block across render branches.The "playground tables" list/markup is now rendered in both the
!userbranch (lines 52–69) and the empty-messages branch (lines 146–159). Consider extracting a smallPlaygroundTablesCalloutcomponent to avoid drift if the table list or copy changes later.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@app/client/src/pages/Chat.tsx` around lines 52 - 69, Extract the duplicated playground callout into a small reusable component (e.g., PlaygroundTablesCallout) and replace the repeated JSX in both render branches with that component; the new component should accept the playgroundTables array (used where map(table) => <li key={table} ...>) and render the Callout with the same title and copy so both the !user branch and the empty-messages branch use <PlaygroundTablesCallout playgroundTables={playgroundTables} /> to avoid duplication and future drift.app/client/src/pages/Documentation.tsx (2)
11-12: Minor:TYPESCRIPT_DOCS_VERSIONduplicatesDOCS_VERSION.Both are
'1.2.5'. If the Python and TypeScript packages are intentionally versioned together you can drop the second constant; if they are meant to diverge, leave a short comment so future bumps aren't mistakenly kept in lockstep.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@app/client/src/pages/Documentation.tsx` around lines 11 - 12, DOCS_VERSION and TYPESCRIPT_DOCS_VERSION are duplicated constants; either remove TYPESCRIPT_DOCS_VERSION and use DOCS_VERSION everywhere if Python and TypeScript docs intentionally share a version, or keep both but add a clarifying comment above TYPESCRIPT_DOCS_VERSION indicating why it mirrors DOCS_VERSION (or that they may diverge), and update any usages (e.g., imports/components referencing TYPESCRIPT_DOCS_VERSION) to reference DOCS_VERSION if you remove the duplicate constant to avoid breaking references.
298-302: Nit: stray leading space inside<code>.
<code> gemini</code>(and similar on line 301/567 elsewhere) will render with a leading space inside the code styling. Move the space outside the tag for cleaner inline typography.Proposed tweak
- (<code>chroma</code> or <code>sqlite</code>) and embedding provider (<code>local</code> or - <code> gemini</code>), then retrieves relevant schema context for your LLM. + (<code>chroma</code> or <code>sqlite</code>) and embedding provider (<code>local</code> or{' '} + <code>gemini</code>), then retrieves relevant schema context for your LLM.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@app/client/src/pages/Documentation.tsx` around lines 298 - 302, In the Callout JSX inside Documentation.tsx the inline code element contains a stray leading space (e.g. "<code> gemini</code>") which will render with unwanted spacing; edit the Callout text (and the other occurrences you noted around the file, e.g. line ~301/567) to move the space outside the <code> tag so the tag contains the identifier only (e.g. <code>gemini</code>) and the surrounding text includes the required space.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@app/client/src/pages/Chat.tsx`:
- Around line 52-69: Extract the duplicated playground callout into a small
reusable component (e.g., PlaygroundTablesCallout) and replace the repeated JSX
in both render branches with that component; the new component should accept the
playgroundTables array (used where map(table) => <li key={table} ...>) and
render the Callout with the same title and copy so both the !user branch and the
empty-messages branch use <PlaygroundTablesCallout
playgroundTables={playgroundTables} /> to avoid duplication and future drift.
In `@app/client/src/pages/Documentation.tsx`:
- Around line 11-12: DOCS_VERSION and TYPESCRIPT_DOCS_VERSION are duplicated
constants; either remove TYPESCRIPT_DOCS_VERSION and use DOCS_VERSION everywhere
if Python and TypeScript docs intentionally share a version, or keep both but
add a clarifying comment above TYPESCRIPT_DOCS_VERSION indicating why it mirrors
DOCS_VERSION (or that they may diverge), and update any usages (e.g.,
imports/components referencing TYPESCRIPT_DOCS_VERSION) to reference
DOCS_VERSION if you remove the duplicate constant to avoid breaking references.
- Around line 298-302: In the Callout JSX inside Documentation.tsx the inline
code element contains a stray leading space (e.g. "<code> gemini</code>") which
will render with unwanted spacing; edit the Callout text (and the other
occurrences you noted around the file, e.g. line ~301/567) to move the space
outside the <code> tag so the tag contains the identifier only (e.g.
<code>gemini</code>) and the surrounding text includes the required space.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 02c98431-d629-48bc-bcf8-d1b0e65a281a
📒 Files selected for processing (4)
app/client/nginx/default.confapp/client/src/pages/About.tsxapp/client/src/pages/Chat.tsxapp/client/src/pages/Documentation.tsx
💤 Files with no reviewable changes (1)
- app/client/nginx/default.conf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…sql also add in about the principal contrubutor of the typescript version
Summary by CodeRabbit