Readme Added#12
Conversation
|
@Yuvraj-Sarathe is attempting to deploy a commit to the utkarsh232005's projects Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis PR adds legal and community documentation to the KDM website. It introduces a code of conduct, contribution guidelines, and comprehensive README covering setup and deployment. Two new static routes render privacy and terms policies; the footer is updated with functional links to these pages, and the root route adds a favicon. ChangesLegal & Policy Pages with Community Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
There was a problem hiding this comment.
Gates Passed
See analysis details in CodeScene
Quality Gate Profile: The Bare Minimum
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 43-56: The project-structure code fence in CONTRIBUTING.md is
missing a language tag (triggering MD040); update the opening fence from ``` to
include a language hint such as ```text (or ```bash/```ansi if preferred) so the
block becomes a proper fenced code block and satisfies markdownlint; no other
content changes required—only modify the opening backticks for the listed src/
tree block.
In `@README.md`:
- Line 19: Update the hard-coded repository URLs in README.md to the canonical
repo; replace occurrences of "https://github.com/Yuvraj-Sarathe/kdm-website"
(used in the contributors badge and the clone instructions around lines 91-92)
with "https://github.com/KDM-cli/kdm-website" so badges and clone examples point
to the correct canonical repository; check for any other instances of the old
owner/repo string and update them consistently.
- Around line 114-151: The README's project-structure code fence lacks a
language tag and incorrectly lists routeTree.gen.ts under src/routes/; update
the fenced block to use a language tag (e.g., ```text) and change the tree line
from "│ │ └── routeTree.gen.ts # Auto-generated route tree" to "│ ├──
routeTree.gen.ts # Auto-generated route tree" (matching the actual file
location), ensuring the fence opens and closes correctly around the block;
modify the lines that mention routeTree.gen.ts and the opening fence token only.
In `@src/components/Footer.tsx`:
- Line 20: In the Footer component update the broken external link href
(currently "https://github.com/KDM-cli/kdm-clim") to the correct repository URL
by replacing that string in the JSX anchor (check the href in Footer.tsx within
the Footer component) — set it to "https://github.com/KDM-cli/kdm-cli" and
confirm the anchor still includes any needed target/rel attributes for external
links.
In `@src/routes/terms.tsx`:
- Around line 24-25: Update the license text in the Terms page component to
match the repository's AGPL v3 license: replace the two lines that currently say
"MIT License" with language stating the software is distributed under the GNU
Affero General Public License v3 (AGPLv3), and update or add a link/reference to
the repository LICENSE (or to https://www.gnu.org/licenses/agpl-3.0.en.html) so
the rendered Terms component reflects AGPL v3 consistently with the rest of the
repo.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: d7a70eb6-50e5-4228-9b6b-48149bc66a0e
⛔ Files ignored due to path filters (1)
src/assets/logo.pngis excluded by!**/*.png
📒 Files selected for processing (8)
CODE_OF_CONDUCT.mdCONTRIBUTING.mdREADME.mdsrc/components/Footer.tsxsrc/routeTree.gen.tssrc/routes/__root.tsxsrc/routes/privacy.tsxsrc/routes/terms.tsx
| ``` | ||
| src/ | ||
| ├── assets/ # Static assets (images, icons) | ||
| ├── components/ # React components | ||
| │ ├── docs/ # Documentation view components | ||
| │ └── ui/ # UI primitives (shadcn/ui) | ||
| ├── hooks/ # React hooks | ||
| ├── lib/ # Utility functions and libraries | ||
| ├── routes/ # TanStack Router route definitions | ||
| ├── router.tsx # Router configuration | ||
| ├── server.ts # SSR error wrapper (entry point) | ||
| ├── start.ts # TanStack Start instance | ||
| └── styles.css # Tailwind CSS v4 styles | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to the project-structure code fence.
Line 43 opens a fenced block without a language hint, which triggers MD040 in markdownlint.
Proposed fix
-```
+```text
src/
├── assets/ # Static assets (images, icons)
├── components/ # React components
│ ├── docs/ # Documentation view components
│ └── ui/ # UI primitives (shadcn/ui)
├── hooks/ # React hooks
├── lib/ # Utility functions and libraries
├── routes/ # TanStack Router route definitions
├── router.tsx # Router configuration
├── server.ts # SSR error wrapper (entry point)
├── start.ts # TanStack Start instance
└── styles.css # Tailwind CSS v4 styles</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>
[warning] 43-43: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @CONTRIBUTING.md around lines 43 - 56, The project-structure code fence in
CONTRIBUTING.md is missing a language tag (triggering MD040); update the opening
fence from to include a language hint such astext (or bash/ansi if
preferred) so the block becomes a proper fenced code block and satisfies
markdownlint; no other content changes required—only modify the opening
backticks for the listed src/ tree block.
</details>
<!-- fingerprinting:phantom:poseidon:hawk -->
<!-- This is an auto-generated comment by CodeRabbit -->
| <p align="center"> | ||
| <a href="https://github.com/KDM-cli/kdm-cli"><img alt="KDM CLI" src="https://img.shields.io/badge/KDM-CLI-000?style=flat-square&logo=kubernetes"></a> | ||
| <a href="LICENSE"><img alt="License: AGPL v3" src="https://img.shields.io/badge/License-AGPL%20v3-blue?style=flat-square"></a> | ||
| <a href="https://github.com/Yuvraj-Sarathe/kdm-website/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/Yuvraj-Sarathe/kdm-website?style=flat-square"></a> |
There was a problem hiding this comment.
Use the canonical repository URL in badges and clone instructions.
Line 19 and Lines 91-92 point to Yuvraj-Sarathe/kdm-website; this PR targets KDM-cli/kdm-website, so docs should default to the canonical repo.
Proposed fix
- <a href="https://github.com/Yuvraj-Sarathe/kdm-website/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/Yuvraj-Sarathe/kdm-website?style=flat-square"></a>
+ <a href="https://github.com/KDM-cli/kdm-website/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/KDM-cli/kdm-website?style=flat-square"></a>-git clone https://github.com/Yuvraj-Sarathe/kdm-website.git
+git clone https://github.com/KDM-cli/kdm-website.git
cd kdm-websiteAlso applies to: 91-92
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 19, Update the hard-coded repository URLs in README.md to
the canonical repo; replace occurrences of
"https://github.com/Yuvraj-Sarathe/kdm-website" (used in the contributors badge
and the clone instructions around lines 91-92) with
"https://github.com/KDM-cli/kdm-website" so badges and clone examples point to
the correct canonical repository; check for any other instances of the old
owner/repo string and update them consistently.
| ``` | ||
| kdm-website/ | ||
| ├── src/ | ||
| │ ├── assets/ # Static assets (logo.png, etc.) | ||
| │ ├── components/ # React components | ||
| │ │ ├── docs/ # Documentation view components | ||
| │ │ ├── ui/ # shadcn/ui primitives | ||
| │ │ ├── Commands.tsx # Interactive command demo section | ||
| │ │ ├── CTA.tsx # Call-to-action section | ||
| │ │ ├── Features.tsx # Features grid section | ||
| │ │ ├── Footer.tsx # Site footer | ||
| │ │ ├── Hero.tsx # Hero section | ||
| │ │ ├── Navbar.tsx # Navigation bar | ||
| │ │ └── Terminal.tsx # Terminal animation component | ||
| │ ├── hooks/ # Custom React hooks | ||
| │ ├── lib/ # Utilities (docs, error handling, etc.) | ||
| │ ├── routes/ # TanStack Router route files | ||
| │ │ ├── __root.tsx # Root layout + SEO config | ||
| │ │ ├── index.tsx # Landing page | ||
| │ │ ├── docs.tsx # Documentation layout | ||
| │ │ ├── docs.index.tsx # Documentation index | ||
| │ │ ├── docs.$slug.tsx # Dynamic doc pages | ||
| │ │ ├── privacy.tsx # Privacy policy | ||
| │ │ ├── terms.tsx # Terms of service | ||
| │ │ └── routeTree.gen.ts # Auto-generated route tree | ||
| │ ├── router.tsx # Router configuration | ||
| │ ├── server.ts # SSR error wrapper | ||
| │ ├── start.ts # TanStack Start instance | ||
| │ └── styles.css # Global styles and Tailwind theme | ||
| ├── .gitignore | ||
| ├── CONTRIBUTING.md # Contribution guidelines | ||
| ├── CODE_OF_CONDUCT.md # Code of conduct | ||
| ├── LICENSE # GNU AGPL v3 | ||
| ├── package.json | ||
| ├── tsconfig.json | ||
| ├── vite.config.ts # Vite configuration | ||
| └── wrangler.jsonc # Cloudflare Workers configuration | ||
| ``` |
There was a problem hiding this comment.
Fix the project-structure block metadata and route-tree path.
Line 114 uses a fenced block without a language tag (MD040), and Line 138 lists routeTree.gen.ts under src/routes/, but the file in this PR is src/routeTree.gen.ts.
Proposed fix
-```
+```text
kdm-website/
├── src/
@@
-│ │ └── routeTree.gen.ts # Auto-generated route tree
+│ ├── routeTree.gen.ts # Auto-generated route tree
@@
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 114-114: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 114 - 151, The README's project-structure code fence
lacks a language tag and incorrectly lists routeTree.gen.ts under src/routes/;
update the fenced block to use a language tag (e.g., ```text) and change the
tree line from "│ │ └── routeTree.gen.ts # Auto-generated route tree" to "│
├── routeTree.gen.ts # Auto-generated route tree" (matching the actual file
location), ensuring the fence opens and closes correctly around the block;
modify the lines that mention routeTree.gen.ts and the opening fence token only.
| Terms | ||
| </Link> | ||
| <a | ||
| href="https://github.com/KDM-cli/kdm-clim" |
There was a problem hiding this comment.
Fix the broken external Status link URL.
Line 20 uses https://github.com/KDM-cli/kdm-clim, which is a typo and results in a dead link.
Proposed fix
- href="https://github.com/KDM-cli/kdm-clim"
+ href="https://github.com/KDM-cli/kdm-cli"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| href="https://github.com/KDM-cli/kdm-clim" | |
| href="https://github.com/KDM-cli/kdm-cli" |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/components/Footer.tsx` at line 20, In the Footer component update the
broken external link href (currently "https://github.com/KDM-cli/kdm-clim") to
the correct repository URL by replacing that string in the JSX anchor (check the
href in Footer.tsx within the Footer component) — set it to
"https://github.com/KDM-cli/kdm-cli" and confirm the anchor still includes any
needed target/rel attributes for external links.
| You may use, modify, and distribute this software in accordance with the terms of the | ||
| MIT License. |
There was a problem hiding this comment.
Align Terms license text with the repository license.
Line 24 and Line 25 state MIT, which conflicts with the AGPL v3 licensing declared elsewhere in this PR and repository docs.
Proposed fix
- You may use, modify, and distribute this software in accordance with the terms of the
- MIT License.
+ You may use, modify, and distribute this software in accordance with the terms of the
+ GNU Affero General Public License v3.0 (AGPL-3.0).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You may use, modify, and distribute this software in accordance with the terms of the | |
| MIT License. | |
| You may use, modify, and distribute this software in accordance with the terms of the | |
| GNU Affero General Public License v3.0 (AGPL-3.0). |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/routes/terms.tsx` around lines 24 - 25, Update the license text in the
Terms page component to match the repository's AGPL v3 license: replace the two
lines that currently say "MIT License" with language stating the software is
distributed under the GNU Affero General Public License v3 (AGPLv3), and update
or add a link/reference to the repository LICENSE (or to
https://www.gnu.org/licenses/agpl-3.0.en.html) so the rendered Terms component
reflects AGPL v3 consistently with the rest of the repo.
1 participant
Readme added
solving issue #10
Summary by CodeRabbit
New Features
Documentation