Docs: Improve frontend README structure#79
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughReplaced the generic Next.js create-next-app README with a Kaapi Frontend–specific README: added badges, Table of Contents, asdf-based Node prerequisites, clone and Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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: 1
🧹 Nitpick comments (1)
README.md (1)
65-65: Relax the.envinstruction to avoid setup confusion.“Do not modify
.env” is likely too strict for local/dev onboarding, where API URLs or keys often need environment-specific values. Recommend changing this to “Only modify documented variables as needed.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 65, Update the README line that currently reads "Do not modify `.env`" to a more permissive instruction such as "Only modify documented variables as needed" (or similar) to allow necessary local/dev adjustments; edit the README.md sentence that contains the exact phrase "Do not modify `.env`" so it clarifies which variables may be changed and points readers to the documented variables or a section describing required environment overrides.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 13: Update the README title and corresponding TOC link from
"Pre-requisite" to the standard plural "Prerequisites" to ensure consistency;
locate the TOC entry "- [Pre-requisite](`#pre-requisite`)" and the section header
"## Pre-requisite" (and the duplicate at the other occurrence) and change both
the link text and the anchor to "Prerequisites" so the TOC and header match.
---
Nitpick comments:
In `@README.md`:
- Line 65: Update the README line that currently reads "Do not modify `.env`" to
a more permissive instruction such as "Only modify documented variables as
needed" (or similar) to allow necessary local/dev adjustments; edit the
README.md sentence that contains the exact phrase "Do not modify `.env`" so it
clarifies which variables may be changed and points readers to the documented
variables or a section describing required environment overrides.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
13-13:⚠️ Potential issue | 🟡 MinorUse “Prerequisites” consistently in TOC and heading.
This repeats an earlier unresolved comment: “Pre-requisite” should be “Prerequisites” for standard terminology and cleaner anchors.
Proposed fix
-- [Pre-requisite](`#pre-requisite`) +- [Prerequisites](`#prerequisites`) ... -## Pre-requisite +## PrerequisitesAlso applies to: 28-28
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 13, Replace the inconsistent "Pre-requisite" text with "Prerequisites" in the README TOC link text ([Pre-requisite](`#pre-requisite`)) and the corresponding section heading (e.g., "## Pre-requisite") so the anchor and heading match the standard term; update both the link label and the section heading to "Prerequisites" (and ensure the anchor becomes `#prerequisites`) to keep the table of contents and heading consistent across the file.
🧹 Nitpick comments (1)
README.md (1)
65-65: Soften.envguidance to avoid blocking valid local setup.“Do not modify
.env” is overly strict and can confuse setup when environment-specific values are required. Suggest guiding users to only edit documented variables.Proposed fix
-2. **Do not modify `.env`** unless absolutely required. +2. Update `.env` only for variables explicitly documented by the project/backend setup.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 65, Replace the overly strict sentence "Do not modify `.env`" with guidance that allows safe local changes: update the README to instruct contributors to only edit documented environment variables (and prefer creating a local copy like `.env.local` or using `.env.example` as a template) when necessary for their environment, and to avoid changing variables not described in the docs or committing `.env` to version control; ensure the change targets the exact line containing "Do not modify `.env`" so the new wording clarifies permitted edits and best practices.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 90-98: Update the README section titled "Available Scripts" to
clarify that `npm install` is a CLI command and not an npm script: change the
`npm install` line to indicate it is the install command (e.g., append " (npm
command)" or move it above the "Available Scripts" list), and leave the `npm run
dev`, `npm run build`, `npm run start`, and `npm run lint` lines as the actual
package.json scripts; edit the README content around the "Available Scripts"
header to reflect this distinction.
---
Duplicate comments:
In `@README.md`:
- Line 13: Replace the inconsistent "Pre-requisite" text with "Prerequisites" in
the README TOC link text ([Pre-requisite](`#pre-requisite`)) and the corresponding
section heading (e.g., "## Pre-requisite") so the anchor and heading match the
standard term; update both the link label and the section heading to
"Prerequisites" (and ensure the anchor becomes `#prerequisites`) to keep the table
of contents and heading consistent across the file.
---
Nitpick comments:
In `@README.md`:
- Line 65: Replace the overly strict sentence "Do not modify `.env`" with
guidance that allows safe local changes: update the README to instruct
contributors to only edit documented environment variables (and prefer creating
a local copy like `.env.local` or using `.env.example` as a template) when
necessary for their environment, and to avoid changing variables not described
in the docs or committing `.env` to version control; ensure the change targets
the exact line containing "Do not modify `.env`" so the new wording clarifies
permitted edits and best practices.
Ayush8923
requested review from
AkhileshNegi,
Prajna1999,
nishika26 and
vprashrex
| | Branch | Environment | | ||
| | --------- | ----------- | | ||
| | `main` | Staging | | ||
| | `release` | Production | |
There was a problem hiding this comment.
i dont think we follow this
There was a problem hiding this comment.
We are planning to follow this approach once the automation deployment is merged, as discussed in the issue comments. That’s why I’ve added it here as well.
There was a problem hiding this comment.
i mean we dont create branch named release, we create a new release. so column name branch is misleading
There was a problem hiding this comment.
Currently, both staging and production are using the same branch. Once the automation deployment is set up, any push to main would directly get deployed to production as well.
To avoid this, the idea was to keep main and release branch separate. This way, any changes pushed to main will go to staging, and whenever we want to deploy to production, we can sync main with release brach. After merging, the release branch will then be used for production deployment.
We’re planning to merge the automation PR soon, so I had updated the README accordingly.
…ntend into docs/frontend-readme-improvement
There was a problem hiding this comment.
♻️ Duplicate comments (6)
README.md (6)
90-98:⚠️ Potential issue | 🟡 MinorRemove
npm installfrom "Available Scripts" or clarify the distinction.
npm installis a built-in npm CLI command, not a script defined inpackage.json. The "Available Scripts" section should only list scripts that usenpm run. Includingnpm installhere is technically inaccurate.📝 Proposed fix to clarify commands vs scripts
Option 1: Remove
npm installfrom this section (it's already covered in the Installation section)## Available Scripts ```bash -npm install # Install dependencies npm run dev # Run app in development mode npm run build # Create optimized production build npm run start # Start the production server npm run lint # Run ESLint**Option 2:** Rename the section to distinguish commands from scripts ```diff -## Available Scripts +## Available Commands and Scripts ```bash -npm install # Install dependencies +npm install # Install dependencies (npm command) npm run dev # Run app in development mode npm run build # Create optimized production build npm run start # Start the production server npm run lint # Run ESLint</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 90 - 98, In the "Available Scripts" section the entry
"npm install" is incorrect because it is not an npm script; remove the "npm
install # Install dependencies" line from under the "Available Scripts"
heading or rename the heading to something like "Commands and Scripts" and
annotate "npm install" as an npm CLI command (e.g., "npm install — Install
dependencies (npm command)") so only actual npm run scripts (npm run dev, npm
run build, npm run start, npm run lint) remain unambiguous.</details> --- `74-76`: _⚠️ Potential issue_ | _🟡 Minor_ **Remove redundant backend reminder.** This section repeats the same information already provided in the note at line 53. The reminder about ensuring the backend is running appears twice, which is redundant. <details> <summary>♻️ Proposed fix to remove redundancy</summary> Consider removing this entire subsection since the note at line 53 already covers this information, or consolidate both reminders into a single location. ```diff ---- - -### Start backend server - -Ensure your Kaapi backend server is running and accessible before proceeding. - --- ### Start frontend server🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 74 - 76, The "### Start backend server" subsection duplicates the earlier backend reminder and should be removed or consolidated; delete the entire "### Start backend server" heading and its two-line note (the repeated sentence "Ensure your Kaapi backend server is running and accessible before proceeding.") or merge its content into the existing note at line 53 so the README contains a single, non-redundant reminder about starting the backend.
13-13:⚠️ Potential issue | 🟡 MinorUse "Prerequisites" (plural) for standard terminology.
The TOC entry uses "Pre-requisite" (singular), but standard documentation terminology uses "Prerequisites" (plural). This should be updated in both the TOC link and the corresponding section header at line 28.
📝 Proposed fix
-- [Pre-requisite](`#pre-requisite`) +- [Prerequisites](`#prerequisites`)Also update line 28:
-## Pre-requisite +## Prerequisites🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 13, Update the TOC entry "[Pre-requisite](`#pre-requisite`)" to use the standard plural "Prerequisites" and also rename the corresponding section header "Pre-requisite" to "Prerequisites" so the link target matches; search for the string "[Pre-requisite](`#pre-requisite`)" and the section header "Pre-requisite" in README.md and change both to "Prerequisites" (and the anchor to "#prerequisites" if present) to keep the table of contents and header consistent.
1-1:⚠️ Potential issue | 🟡 MinorChange title to "Kaapi Frontend" for clarity.
The current title "# Kaapi" doesn't clarify that this is the frontend repository. Since this is the
kaapi-frontendrepo, the title should explicitly state "Kaapi Frontend" to distinguish it from the backend or other components.📝 Proposed fix
-# Kaapi +# Kaapi Frontend🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 1, Update the repository README header to explicitly indicate this is the frontend: replace the existing top-level title string "# Kaapi" with "# Kaapi Frontend" so the README clearly identifies the repository as the kaapi-frontend project.
7-7:⚠️ Potential issue | 🟡 MinorRevise description to focus on frontend and remove "Evidential".
The description should:
- Remove "Evidential" from the list of platforms
- Focus specifically on this being the frontend UI for Kaapi (e.g., "This is the frontend interface/thin UI layer for Kaapi backend")
- Link to the backend repository instead of describing the entire platform
📝 Proposed fix
-Kaapi is Project Tech4Dev's AI platform that accelerates responsible AI adoption by acting as a middleware layer, enabling platforms like Avni, Glific, Evidential, and Dalgo to seamlessly integrate AI functionality without building or maintaining their own infrastructure. This is the frontend interface built using Next.js. +Kaapi Frontend is the user interface for [Kaapi](https://github.com/ProjectTech4DevAI/kaapi-backend), Project Tech4Dev's AI platform that accelerates responsible AI adoption. This Next.js application provides a thin UI layer that connects to the Kaapi backend, enabling platforms like Avni, Glific, and Dalgo to interact with AI functionality.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 7, Update the README sentence that currently describes Kaapi as a platform front-to-back: remove "Evidential" from the platform list, rephrase the sentence to state this repo is the frontend interface / thin UI layer for the Kaapi backend (e.g., "This is the frontend interface/thin UI layer for the Kaapi backend built with Next.js"), and replace the broad platform description with a short link reference to the backend repository (insert the backend repo URL or repo name) instead of describing the entire platform; edit the existing line that begins "Kaapi is Project Tech4Dev’s AI platform..." to implement these changes.
51-51:⚠️ Potential issue | 🟡 MinorConvert raw URL to markdown hyperlink.
The backend repository URL is displayed as raw text. For better readability, convert it to a markdown hyperlink.
📝 Proposed fix
-You need to set up the Kaapi backend service. Follow the instructions here: 🔗 https://github.com/ProjectTech4DevAI/kaapi-backend +You need to set up the Kaapi backend service. Follow the instructions here: 🔗 [Kaapi Backend](https://github.com/ProjectTech4DevAI/kaapi-backend)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 51, Replace the raw URL in the README line that reads "You need to set up the Kaapi backend service. Follow the instructions here: 🔗 https://github.com/ProjectTech4DevAI/kaapi-backend" with a Markdown link; edit the README line so the text uses link syntax (for example "Follow the instructions here: 🔗 https://github.com/ProjectTech4DevAI/kaapi-backend" -> "Follow the instructions here: 🔗 [kaapi-backend](https://github.com/ProjectTech4DevAI/kaapi-backend)") to render a proper clickable hyperlink.
🧹 Nitpick comments (1)
README.md (1)
65-65: Consider simplifying "absolutely required" for conciseness.The phrase "absolutely required" could be simplified to "required" or "necessary" for more concise documentation.
♻️ Proposed simplification
-2. **Do not modify `.env`** unless absolutely required. +2. **Do not modify `.env`** unless required.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 65, Replace the phrase "absolutely required" in the README instruction "Do not modify `.env` unless absolutely required." with a more concise word such as "required" or "necessary" (e.g., "Do not modify `.env` unless required.") — locate the sentence containing `.env` and the exact text "absolutely required" and update it accordingly in the README.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@README.md`:
- Around line 90-98: In the "Available Scripts" section the entry "npm install"
is incorrect because it is not an npm script; remove the "npm install #
Install dependencies" line from under the "Available Scripts" heading or rename
the heading to something like "Commands and Scripts" and annotate "npm install"
as an npm CLI command (e.g., "npm install — Install dependencies (npm command)")
so only actual npm run scripts (npm run dev, npm run build, npm run start, npm
run lint) remain unambiguous.
- Around line 74-76: The "### Start backend server" subsection duplicates the
earlier backend reminder and should be removed or consolidated; delete the
entire "### Start backend server" heading and its two-line note (the repeated
sentence "Ensure your Kaapi backend server is running and accessible before
proceeding.") or merge its content into the existing note at line 53 so the
README contains a single, non-redundant reminder about starting the backend.
- Line 13: Update the TOC entry "[Pre-requisite](`#pre-requisite`)" to use the
standard plural "Prerequisites" and also rename the corresponding section header
"Pre-requisite" to "Prerequisites" so the link target matches; search for the
string "[Pre-requisite](`#pre-requisite`)" and the section header "Pre-requisite"
in README.md and change both to "Prerequisites" (and the anchor to
"#prerequisites" if present) to keep the table of contents and header
consistent.
- Line 1: Update the repository README header to explicitly indicate this is the
frontend: replace the existing top-level title string "# Kaapi" with "# Kaapi
Frontend" so the README clearly identifies the repository as the kaapi-frontend
project.
- Line 7: Update the README sentence that currently describes Kaapi as a
platform front-to-back: remove "Evidential" from the platform list, rephrase the
sentence to state this repo is the frontend interface / thin UI layer for the
Kaapi backend (e.g., "This is the frontend interface/thin UI layer for the Kaapi
backend built with Next.js"), and replace the broad platform description with a
short link reference to the backend repository (insert the backend repo URL or
repo name) instead of describing the entire platform; edit the existing line
that begins "Kaapi is Project Tech4Dev’s AI platform..." to implement these
changes.
- Line 51: Replace the raw URL in the README line that reads "You need to set up
the Kaapi backend service. Follow the instructions here: 🔗
https://github.com/ProjectTech4DevAI/kaapi-backend" with a Markdown link; edit
the README line so the text uses link syntax (for example "Follow the
instructions here: 🔗 https://github.com/ProjectTech4DevAI/kaapi-backend" ->
"Follow the instructions here: 🔗
[kaapi-backend](https://github.com/ProjectTech4DevAI/kaapi-backend)") to render
a proper clickable hyperlink.
---
Nitpick comments:
In `@README.md`:
- Line 65: Replace the phrase "absolutely required" in the README instruction
"Do not modify `.env` unless absolutely required." with a more concise word such
as "required" or "necessary" (e.g., "Do not modify `.env` unless required.") —
locate the sentence containing `.env` and the exact text "absolutely required"
and update it accordingly in the README.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
README.md (2)
85-93:⚠️ Potential issue | 🟡 MinorSeparate CLI commands from npm scripts.
The section "Available Scripts" mixes the
npm installcommand (a CLI command) with actual package.json scripts (dev,build,start,lint). This is a documentation accuracy issue.📝 Proposed fix
-## Available Scripts +## Available Commands and Scripts ```bash -npm install # Install dependencies +npm install # Install dependencies (CLI command) npm run dev # Run app in development mode npm run build # Create optimized production build npm run start # Start the production server npm run lint # Run ESLintOr move `npm install` to the Installation section where it belongs, since it's already documented at lines 67-71. </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 85 - 93, The "Available Scripts" section currently
mixes a CLI command with package.json scripts; move or relabel thenpm install
entry so scripts list contains only npm scripts. Either relocatenpm install
to the Installation section (where similar content exists) or annotate it as a
CLI command (e.g., "npm install — Install dependencies (CLI command)"), and
leavenpm run dev,npm run build,npm run start, andnpm run lintas the
only items under "Available Scripts" to accurately reflect package.json scripts.</details> --- `13-13`: _⚠️ Potential issue_ | _🟡 Minor_ **Use "Prerequisites" (plural) for standard terminology.** The section should be titled "Prerequisites" rather than "Pre-requisite" for consistency with standard documentation conventions. This applies to both the TOC link and the section header at line 27. <details> <summary>📝 Proposed fix</summary> ```diff -- [Pre-requisite](`#pre-requisite`) +- [Prerequisites](`#prerequisites`)Also update line 27:
-## Pre-requisite +## Prerequisites🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 13, Update the TOC entry "[Pre-requisite](`#pre-requisite`)" and the corresponding section header "Pre-requisite" to use standard plural wording "Prerequisites" and ensure the anchor matches (e.g., change the link to "[Prerequisites](`#prerequisites`)" and the header text to "## Prerequisites") so both the table of contents and the section heading are consistent.
🧹 Nitpick comments (4)
README.md (4)
97-116: Clarify if deployment automation is active or planned.Based on past review discussion, the CD pipeline may not be fully implemented yet. Consider adding a note at the beginning of this section to clarify the current status, e.g.:
## Deploying Release on EC2 with CD +> ⚠️ Note: This deployment automation is currently being implemented. See [issue `#22`](https://github.com/ProjectTech4DevAI/kaapi-frontend/issues/22) for progress. + Deployments are automated via a GitHub Actions CD pipeline...This helps readers understand whether they can rely on this automation today or if it's a future enhancement.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 97 - 116, Update the "## Deploying Release on EC2 with CD" section in README.md to state whether the CD pipeline is currently active or only planned; at the top of that section (immediately under the heading) add a single clarifying sentence like "Status: [Active | Planned]" or a short note explaining current rollout status and any caveats so readers know if the SSH/git build/restart automation is available now; ensure the note references the CD pipeline described in the section so it's unambiguous for readers.
1-1: Consider using "Kaapi Frontend" (space) instead of "Kaapi-Frontend" (hyphen).Per past review feedback, the title should match the repository naming convention. "Kaapi Frontend" (with a space) is more standard for product names, while the hyphenated form is typically reserved for repository URLs.
📝 Proposed title adjustment
-# Kaapi-Frontend +# Kaapi Frontend🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 1, Change the README title header string from "Kaapi-Frontend" to "Kaapi Frontend" so the project display name follows the repository naming convention; update the top-level markdown header (the line currently containing "# Kaapi-Frontend") to "# Kaapi Frontend" and ensure any other occurrences of the hyphenated project name in the README are replaced to maintain consistency.
42-44: Consider adding HTTPS clone alternative.The SSH clone URL requires contributors to have SSH keys configured with GitHub. For first-time contributors or those without SSH setup, consider adding the HTTPS alternative as well.
🔗 Proposed addition
```bash +# SSH (requires SSH keys configured) git clone git@github.com:ProjectTech4DevAI/kaapi-frontend.git + +# HTTPS (no SSH keys required) +git clone https://github.com/ProjectTech4DevAI/kaapi-frontend.git</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@README.mdaround lines 42 - 44, Add an HTTPS clone alternative next to the
existing SSH example so contributors without SSH keys can clone the repo; locate
the existing SSH line "git clone
git@github.com:ProjectTech4DevAI/kaapi-frontend.git" in the README and insert a
second line with the HTTPS form "git clone
https://github.com/ProjectTech4DevAI/kaapi-frontend.git", optionally labeling
which is SSH vs HTTPS for clarity.</details> --- `64-64`: **Reconsider the .env modification warning.** The instruction "Do not modify `.env` unless absolutely required" is unusual, as `.env` files are typically meant to be customized for local development. If the defaults in `.env.example` work for most contributors, consider either: 1. Removing this warning entirely 2. Clarifying which specific variables should not be changed 3. Simplifying the language (e.g., "The defaults should work for local development") Additionally, "absolutely required" is wordy; "necessary" or "needed" would be more concise. <details> <summary>📝 Proposed alternatives</summary> **Option 1: Clarify which variables not to change** ```diff -2. **Do not modify `.env`** unless absolutely required. +2. The default values should work for local development. Only modify `.env` if you need to point to a different backend URL.Option 2: Simplify
-2. **Do not modify `.env`** unless absolutely required. +2. The defaults in `.env` should work for most development scenarios.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 64, Replace or reword the sentence "Do not modify `.env` unless absolutely required." in README.md: either remove it entirely or replace it with a concise, clearer instruction such as "The defaults in .env.example should work for local development; modify .env only when necessary." or, alternatively, specify which variables must not be changed by naming them explicitly. Ensure the updated line uses "necessary" instead of "absolutely required" if keeping the warning.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 31-36: Update the "npm (via asdf)" section in README.md to first
state that asdf must be installed (link to https://asdf-vm.com/) and then
document the required Node.js version; either add a .tool-versions file to the
repo root specifying that Node version or explicitly instruct readers which Node
version to install and how to set it with asdf (e.g., asdf install nodejs
<version> and asdf local nodejs <version>), so that the existing `asdf install`
step works reliably.
---
Duplicate comments:
In `@README.md`:
- Around line 85-93: The "Available Scripts" section currently mixes a CLI
command with package.json scripts; move or relabel the `npm install` entry so
scripts list contains only npm scripts. Either relocate `npm install` to the
Installation section (where similar content exists) or annotate it as a CLI
command (e.g., "npm install — Install dependencies (CLI command)"), and leave
`npm run dev`, `npm run build`, `npm run start`, and `npm run lint` as the only
items under "Available Scripts" to accurately reflect package.json scripts.
- Line 13: Update the TOC entry "[Pre-requisite](`#pre-requisite`)" and the
corresponding section header "Pre-requisite" to use standard plural wording
"Prerequisites" and ensure the anchor matches (e.g., change the link to
"[Prerequisites](`#prerequisites`)" and the header text to "## Prerequisites") so
both the table of contents and the section heading are consistent.
---
Nitpick comments:
In `@README.md`:
- Around line 97-116: Update the "## Deploying Release on EC2 with CD" section
in README.md to state whether the CD pipeline is currently active or only
planned; at the top of that section (immediately under the heading) add a single
clarifying sentence like "Status: [Active | Planned]" or a short note explaining
current rollout status and any caveats so readers know if the SSH/git
build/restart automation is available now; ensure the note references the CD
pipeline described in the section so it's unambiguous for readers.
- Line 1: Change the README title header string from "Kaapi-Frontend" to "Kaapi
Frontend" so the project display name follows the repository naming convention;
update the top-level markdown header (the line currently containing "#
Kaapi-Frontend") to "# Kaapi Frontend" and ensure any other occurrences of the
hyphenated project name in the README are replaced to maintain consistency.
- Around line 42-44: Add an HTTPS clone alternative next to the existing SSH
example so contributors without SSH keys can clone the repo; locate the existing
SSH line "git clone git@github.com:ProjectTech4DevAI/kaapi-frontend.git" in the
README and insert a second line with the HTTPS form "git clone
https://github.com/ProjectTech4DevAI/kaapi-frontend.git", optionally labeling
which is SSH vs HTTPS for clarity.
- Line 64: Replace or reword the sentence "Do not modify `.env` unless
absolutely required." in README.md: either remove it entirely or replace it with
a concise, clearer instruction such as "The defaults in .env.example should work
for local development; modify .env only when necessary." or, alternatively,
specify which variables must not be changed by naming them explicitly. Ensure
the updated line uses "necessary" instead of "absolutely required" if keeping
the warning.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
README.md (4)
91-99:⚠️ Potential issue | 🟡 Minor
npm installis not an npm script.The past review comment about
npm installnot being a package.json script has not been addressed. It should either be moved out of the "Available Scripts" section or the section should be renamed to clarify the distinction between npm commands and scripts.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 91 - 99, The "npm install" line under the "Available Scripts" section is incorrect because it's not a package.json script; either remove "npm install" from the list and place it under a new "Prerequisites" or "Setup" section, or rename the heading "Available Scripts" to something like "Common Commands" to clarify it includes non-script commands; update the README.md "## Available Scripts" block to reflect this change and keep the remaining npm run commands (npm run dev, build, start, lint) under the scripts heading.
27-27:⚠️ Potential issue | 🟡 MinorUse "Prerequisites" for consistency.
The section header still uses the singular form. See comment on line 13.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 27, Replace the header "## Pre-requisite" with "## Prerequisites" to match the plural form used elsewhere; update the exact header string in the README (search for "Pre-requisite") so the section title is consistent with the other "Prerequisites" occurrences.
13-13:⚠️ Potential issue | 🟡 MinorUse "Prerequisites" for consistency.
The past review comment about changing "Pre-requisite" to "Prerequisites" has not been addressed. This applies to both the TOC entry (line 13) and the section header (line 27).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 13, Replace the inconsistent "Pre-requisite" wording with "Prerequisites" in both places: update the TOC entry text "[Pre-requisite](`#pre-requisite`)" to "[Prerequisites](`#prerequisites`)" and rename the section header "## Pre-requisite" (or any header line containing the exact phrase "Pre-requisite") to "## Prerequisites" so the link anchor and header text match.
31-36:⚠️ Potential issue | 🟠 MajorDocument asdf prerequisite and .tool-versions file requirement.
The past review comment about missing asdf installation instructions and the missing
.tool-versionsfile has not been addressed. Users cannot runasdf installwithout a.tool-versionsfile in the repository root.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 31 - 36, Update the README to document that asdf is a prerequisite and that the repository must include a .tool-versions file; add text before the npm/asdf snippet explaining users should install asdf (link optional) and that they must have a .tool-versions file in the repo root (or copy one) so that running `asdf install` works, and ensure the expected nodejs version is reflected in that .tool-versions file (create or include the .tool-versions file in the repo if missing and reference the filename explicitly in the README).
🧹 Nitpick comments (1)
README.md (1)
70-70: Optional: Consider simplifying wording."unless absolutely required" could be shortened to "unless required" for conciseness. However, the emphasis on "absolutely" may be intentional to strongly discourage manual edits.
As per coding guidelines, static analysis flagged: 'absolutely required' might be wordy. Consider a shorter alternative.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 70, Update the README sentence "Do not modify `.env` unless absolutely required." to a more concise version—e.g., "Do not modify `.env` unless required."—by removing "absolutely" to satisfy the static analysis guideline; locate the exact sentence in the README (the line that mentions `.env`) and replace the phrase accordingly while preserving the original intent and emphasis.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 64-68: The README references copying a missing .env.example which
causes setup to fail; add a .env.example in the project root containing a
default BACKEND_URL (matching the fallback used by process.env.BACKEND_URL) so
the cp step works, and ensure the README's step still instructs users to copy
.env.example to .env; alternatively (choose one) update the README step to
remove the cp command and instead instruct users to create a .env with
BACKEND_URL set to http://localhost:8000, referencing process.env.BACKEND_URL in
the docs so readers know the default value.
---
Duplicate comments:
In `@README.md`:
- Around line 91-99: The "npm install" line under the "Available Scripts"
section is incorrect because it's not a package.json script; either remove "npm
install" from the list and place it under a new "Prerequisites" or "Setup"
section, or rename the heading "Available Scripts" to something like "Common
Commands" to clarify it includes non-script commands; update the README.md "##
Available Scripts" block to reflect this change and keep the remaining npm run
commands (npm run dev, build, start, lint) under the scripts heading.
- Line 27: Replace the header "## Pre-requisite" with "## Prerequisites" to
match the plural form used elsewhere; update the exact header string in the
README (search for "Pre-requisite") so the section title is consistent with the
other "Prerequisites" occurrences.
- Line 13: Replace the inconsistent "Pre-requisite" wording with "Prerequisites"
in both places: update the TOC entry text "[Pre-requisite](`#pre-requisite`)" to
"[Prerequisites](`#prerequisites`)" and rename the section header "##
Pre-requisite" (or any header line containing the exact phrase "Pre-requisite")
to "## Prerequisites" so the link anchor and header text match.
- Around line 31-36: Update the README to document that asdf is a prerequisite
and that the repository must include a .tool-versions file; add text before the
npm/asdf snippet explaining users should install asdf (link optional) and that
they must have a .tool-versions file in the repo root (or copy one) so that
running `asdf install` works, and ensure the expected nodejs version is
reflected in that .tool-versions file (create or include the .tool-versions file
in the repo if missing and reference the filename explicitly in the README).
---
Nitpick comments:
In `@README.md`:
- Line 70: Update the README sentence "Do not modify `.env` unless absolutely
required." to a more concise version—e.g., "Do not modify `.env` unless
required."—by removing "absolutely" to satisfy the static analysis guideline;
locate the exact sentence in the README (the line that mentions `.env`) and
replace the phrase accordingly while preserving the original intent and
emphasis.
3 participants
Issue: #77
Summary:
Summary by CodeRabbit