chore: fix terminology and add .claude to gitignore#4
chore: fix terminology and add .claude to gitignore#4Prajjawalk merged 1 commit intoCLEAR-Initiative:mainfrom
Conversation
Replace "environmental" with "humanitarian" in API docs — CLEAR is a humanitarian crisis intelligence platform, not an environmental/climate tool. Also ignore /.claude to prevent AI tool configs and credentials leaking into version control. Made-with: Cursor
📝 WalkthroughWalkthroughThe pull request adds a Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 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 unit tests (beta)
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: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/docs/template.ts (1)
72-77:⚠️ Potential issue | 🟠 MajorRemove
typesByKindto get CI passing again.This object is never read, and CI is already failing on
@typescript-eslint/no-unused-varsfor it. If the grouped view is no longer needed, delete the declaration instead of leaving dead code.🧹 Proposed fix
export function renderDocsPage(schema: SchemaData): string { - const typesByKind = { - scalar: schema.types.filter((t) => t.kind === "scalar"), - enum: schema.types.filter((t) => t.kind === "enum"), - input: schema.types.filter((t) => t.kind === "input"), - object: schema.types.filter((t) => t.kind === "object"), - }; - return `<!DOCTYPE html>As per coding guidelines,
**/*.{ts,tsx}: Use ESLint and Prettier for code linting and formatting.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/docs/template.ts` around lines 72 - 77, The unused constant typesByKind is causing an ESLint no-unused-vars error; remove the entire declaration of typesByKind (the const typesByKind = { ... } block that filters schema.types for scalar/enum/input/object) so there is no dead code left in the module and CI will stop failing.
🧹 Nitpick comments (1)
src/docs/template.ts (1)
244-245: Prefer deriving these feature links from the schema.These anchors are hard-coded, but the target sections are generated from
schema.typesusingtype-${type.name.toLowerCase()}. If either type is absent or renamed in a given schema snapshot, this table will render dead in-page links.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/docs/template.ts` around lines 244 - 245, The table in src/docs/template.ts hard-codes anchors for "Feature Flags" and "API Keys" which can become dead links; instead derive entries from schema.types so anchors match generated sections. Update the code that renders the table to iterate over schema.types (the same source used to build section IDs like `type-${type.name.toLowerCase()}`), generate rows only for types present, and compute hrefs using `#type-${type.name.toLowerCase()}` and the corresponding human-readable label (e.g., type.displayName or type.name mapping) so links always align with the generated sections.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.gitignore:
- 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.
---
Outside diff comments:
In `@src/docs/template.ts`:
- Around line 72-77: The unused constant typesByKind is causing an ESLint
no-unused-vars error; remove the entire declaration of typesByKind (the const
typesByKind = { ... } block that filters schema.types for
scalar/enum/input/object) so there is no dead code left in the module and CI
will stop failing.
---
Nitpick comments:
In `@src/docs/template.ts`:
- Around line 244-245: The table in src/docs/template.ts hard-codes anchors for
"Feature Flags" and "API Keys" which can become dead links; instead derive
entries from schema.types so anchors match generated sections. Update the code
that renders the table to iterate over schema.types (the same source used to
build section IDs like `type-${type.name.toLowerCase()}`), generate rows only
for types present, and compute hrefs using `#type-${type.name.toLowerCase()}`
and the corresponding human-readable label (e.g., type.displayName or type.name
mapping) so links always align with the generated sections.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fd16cc06-9096-4514-be8c-08e1dff96d23
📒 Files selected for processing (2)
.gitignoresrc/docs/template.ts
| .DS_Store No newline at end of file | ||
| .DS_Store | ||
|
|
||
| /.claude |
There was a problem hiding this comment.
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.
2 participants
minor changes to documentation and gitignore