Skip to content

chore: fix terminology and add .claude to gitignore #4

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
Prajjawalk merged 1 commit into from
Mar 12, 2026
Merged

chore: fix terminology and add .claude to gitignore #4

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
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ dist
.terraform.lock.hcl

/src/generated/prisma
.DS_Store
.DS_Store

/.claude
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Untrack .claude in this PR or the ignore rule won't actually help.

/.claude only prevents new untracked files from being added. Since .claude/settings.json was already committed, Git will keep tracking future edits until you remove .claude from the index as part of this change.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.gitignore at line 15, The .gitignore entry alone won't untrack the already
committed .claude directory; remove .claude from the repo index and commit that
change so the new /.claude ignore rule takes effect: run a git remove-from-index
command for the .claude path (e.g., git rm --cached -r .claude), commit the
deletion, and ensure the repository no longer contains .claude/settings.json;
keep the /.claude line in .gitignore so future files are ignored.

12 changes: 4 additions & 8 deletions src/docs/template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,7 @@ function renderFieldRow(field: SchemaField): string {
</tr>`;
}

function renderOperationSection(
title: string,
id: string,
fields: SchemaField[],
): string {
function renderOperationSection(title: string, id: string, fields: SchemaField[]): string {
if (!fields.length) return "";
return `
<h2 id="${id}">${escapeHtml(title)}</h2>
Expand Down Expand Up @@ -231,17 +227,17 @@ export function renderDocsPage(schema: SchemaData): string {
<div id="section-introduction">
<p style="font-size:0.8rem;color:var(--color-muted);margin-bottom:0.25rem;">Docs &rsaquo; GET STARTED &rsaquo; <strong>Introduction</strong></p>
<h1 id="introduction">Introduction</h1>
<p class="subtitle">Welcome to the CLEAR API &mdash; your gateway to environmental intelligence.</p>
<p class="subtitle">Welcome to the CLEAR API - your gateway to humanitarian intelligence.</p>

<p>The CLEAR API gives you programmatic access to environmental alerts, detection events, data sources, and geographic location data through a single GraphQL endpoint. Whether you&rsquo;re building a monitoring dashboard, integrating alerts into your workflow, or analysing detection patterns, this API has you covered.</p>
<p>The CLEAR API gives you programmatic access to alerts, detection events, data sources, and geographic location data through a single GraphQL endpoint. Whether you&rsquo;re building a monitoring dashboard, integrating alerts into your workflow, or analysing detection patterns, this API has you covered.</p>

<p>Everything here is accessible via GraphQL at <code>/graphql</code>. You send a query describing exactly the data you want, and you get back precisely that &mdash; nothing more, nothing less.</p>

<h2 id="features">What You Can Do</h2>
<table class="feature-table">
<thead><tr><th>Feature</th><th>Description</th></tr></thead>
<tbody>
<tr><td><a href="#type-alert">Alerts</a></td><td>Browse, filter, and inspect environmental alerts with severity levels and geographic scope.</td></tr>
<tr><td><a href="#type-alert">Alerts</a></td><td>Browse, filter, and inspect humanitarian alerts with severity levels and geographic scope.</td></tr>
<tr><td><a href="#type-detection">Detections</a></td><td>Access raw and processed detection events from multiple data sources with confidence scores.</td></tr>
<tr><td><a href="#type-datasource">Data Sources</a></td><td>Discover the external data sources that feed into the platform (satellites, sensors, manual reports).</td></tr>
<tr><td><a href="#type-location">Locations</a></td><td>Query a hierarchical geographic tree &mdash; countries, states, cities &mdash; and see what&rsquo;s happening where.</td></tr>
Expand Down
Loading