Skip to content

add: add new documentation, link with pypi and npm version of natural… #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zay-M3 merged 1 commit into from
Apr 19, 2026
Merged

add: add new documentation, link with pypi and npm version of natural… #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 0 additions & 87 deletions app/client/nginx/default.conf
View file
Open in desktop

This file was deleted.

19 changes: 18 additions & 1 deletion app/client/src/pages/About.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default function About() {
database structure.
</p>

<img src="/img/naturalsql.png" alt="NaturalSQL logo" className="h-60 w-auto" />
<img src="/img/naturalsql.png" alt="NaturalSQL logo" className="mx-auto h-72 w-auto sm:h-80" />
</div>

<GitHubProjectBadge
Expand Down Expand Up @@ -54,6 +54,23 @@ export default function About() {
</p>
</div>
</div>

<div className="mt-6 rounded-2xl border border-emerald-200 bg-emerald-50/70 p-4">
<p className="text-xs font-semibold uppercase tracking-[0.14em] text-emerald-700">
TypeScript version contributor
</p>
<p className="mt-2 text-sm leading-relaxed text-slate-700">
Main contributor and builder of the TypeScript version.
</p>
<GitHubProjectBadge
owner="JosephAnderson234"
repo="NaturalSQL"
variant="detailed"
showCreator={false}
showBio={true}
className="mt-3 rounded-xl border border-emerald-100 bg-white/90"
/>
</div>
</section>
</div>
</main>
Expand Down
50 changes: 45 additions & 5 deletions app/client/src/pages/Chat.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,51 @@ export const Chat = () => {
<p className="font-serif text-4xl tracking-tight text-emerald-800/80 sm:text-5xl">NaturalSQL</p>
</li>
<h2 className="text-2xl text-slate-800 text-center">Please log in to access the chat.</h2>

<div className="mt-6 px-4 sm:px-6">
<Callout title="How the playground works">
<p className="mb-3">
This chat is connected to a fixed playground database. Ask questions that are related to
the existing schema and tables shown below.
</p>
<p className="mb-3 text-sm text-slate-700">
Questions outside this database context can produce irrelevant answers.
</p>
<ul className="grid grid-cols-2 gap-x-6 gap-y-1 text-sm sm:grid-cols-3">
{playgroundTables.map((table) => (
<li key={table} className="font-medium text-emerald-900/90">
{table}
</li>
))}
</ul>
</Callout>
</div>

<div className="mt-4 px-4 sm:px-6">
<Callout title="Use NaturalSQL in your own project">
<p className="mb-4 text-sm text-slate-700">
Explore and install the package from your preferred ecosystem.
</p>
<div className="flex flex-wrap gap-3">
<a
href="https://www.npmjs.com/package/naturalsql"
target="_blank"
rel="noreferrer"
className="inline-flex items-center justify-center rounded-full bg-emerald-700 px-4 py-2 text-sm font-semibold text-white transition hover:bg-emerald-800"
>
Open on npm
</a>
<a
href="https://pypi.org/project/naturalsql/"
target="_blank"
rel="noreferrer"
className="inline-flex items-center justify-center rounded-full border border-emerald-300 bg-white px-4 py-2 text-sm font-semibold text-emerald-800 transition hover:bg-emerald-50"
>
Open on PyPI
</a>
</div>
</Callout>
</div>
</div>
</main>
)
Expand Down Expand Up @@ -179,8 +224,3 @@ export const Chat = () => {
)
}

// {messages.length === 0 ? (
// <li className="flex items-center justify-center py-8">
// <p className="font-serif text-4xl tracking-tight text-slate-300 sm:text-5xl">NaturalSQL</p>
// </li>
// ) : null}
Loading
Loading