Skip to content

Improvement] Fix metadata links, setup docs, and env placeholders#71

Merged
amanintech merged 2 commits intoLamatic:mainfrom
amanyadav721:fix/agentkit-links-and-docs
Mar 23, 2026
Merged

Improvement] Fix metadata links, setup docs, and env placeholders#71
amanintech merged 2 commits intoLamatic:mainfrom
amanyadav721:fix/agentkit-links-and-docs

Conversation

@amanyadav721
Copy link
Copy Markdown
Contributor

@amanyadav721 amanyadav721 commented Mar 6, 2026

Fix invalid githubUrl values in bundle/kit config.json
Correct root setup instructions in README.md (kits path + run commands)
Fix copied env placeholders in Sheets and Blog Automation examples
Fix broken local README links to LICENSE by pointing to repo root
Minor grammar-extension README link fix (lamatic-config-example.json)

Summary by CodeRabbit

  • Documentation

    • Clarified setup and kit/template guidance, updated run-local instructions, and corrected license reference paths across READMEs.
    • Updated several user-facing descriptions (environment notes and hero image guidance).
  • Chores

    • Fixed config repository links for multiple bundles and kits.
    • Normalized .env example formatting and adjusted default placeholder values where applicable.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 39484633-9cec-4f56-a1ba-2bf96aceb5af

📥 Commits

Reviewing files that changed from the base of the PR and between 75c6b69 and 5028f29.

📒 Files selected for processing (8)
  • README.md
  • kits/agentic/deep-search/.env.example
  • kits/agentic/generation/.env.example
  • kits/automation/hiring/.env.example
  • kits/embed/chat/.env.example
  • kits/embed/search/.env.example
  • kits/embed/sheets/.env.example
  • kits/sample/content-generation/.env.example
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Bundle and kit metadata URLs and README license paths were corrected; numerous .env.example files were reformatted (removed spaces around =) and some env defaults updated to kit-specific FLOW IDs; README guidance and image/source paths for the agentic deep-search kit were adjusted.

Changes

Cohort / File(s) Summary
Root README
README.md
Updated guidance (browse /kits vs /templates), changed image Light-mode source path, clarified env file usage (.env/.env.local), renamed "Deploy" → "Run Locally" and updated local run commands.
Bundle configs
bundles/assistants/config.json, bundles/document-parsing/config.json, bundles/knowledge-chatbot/config.json, bundles/sample/chatbot/config.json, bundles/semantic-search/config.json
Repointed githubUrl fields to the correct bundle-specific repository paths (fixes incorrect chat bundle links).
Kit configs
kits/assistant/grammar-extension/config.json
Updated githubUrl to grammar-extension path and cleared documentationUrl.
License path fixes
kits/agentic/generation/README.md, kits/assistant/grammar-extension/README.md, kits/automation/hiring/README.md, kits/embed/chat/README.md, kits/embed/search/README.md, kits/sample/content-generation/README.md
Rewrote relative license links from ./LICENSE to ../../../LICENSE.
Env formatting & defaults
kits/agentic/deep-search/.env.example, kits/agentic/generation/.env.example, kits/automation/hiring/.env.example, kits/embed/chat/.env.example, kits/embed/search/.env.example, kits/sample/content-generation/.env.example, kits/embed/sheets/.env.example
Normalized .env formatting (removed spaces around =), and updated several placeholder values to kit-specific FLOW ID placeholders where applicable.
Kit docs / wording changes
kits/assistant/grammar-extension/README.md, kits/automation/blog-automation/.env.example, kits/embed/chat/README.md, kits/embed/search/README.md, kits/embed/sheets/README.md, kits/sample/content-generation/README.md
Updated setup text (config file guidance, blob/upload wording), changed onboarding phrasing and example placeholders, and adjusted README kit-selection guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • Ops #47 — Overlapping documentation and env-formatting edits (env whitespace normalization and setup guidance).
  • Fix : Vercel Links #54 — Related updates to kit paths and repository URL/link fixes for agentic deep-search.
  • Ops #59 — Edits touching kits/agentic/deep-search/README.md (image/link/deploy adjustments).

Suggested reviewers

  • d-pamneja

Poem

🐰 I hopped through files, tidied each trail,

Paths aligned and envs set without fail.
Licenses found their proper home,
URLs guided no more to roam,
A little rabbit’s tidy commit tale. 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly addresses the main changes: fixing metadata links in config files, correcting setup documentation paths and commands, and normalizing environment variable placeholders across multiple kits and bundles.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
kits/sample/content-generation/README.md (1)

12-12: ⚠️ Potential issue | 🟠 Major

Deploy button still points at a different kit.

Line 12 still sets root-directory=kits/agentic/generation, but this README is for kits/sample/content-generation. Users following this page will deploy the wrong subdirectory.

Suggested fix
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/Lamatic/AgentKit&root-directory=kits/agentic/generation&env=AGENTIC_GENERATE_CONTENT,LAMATIC_API_URL,LAMATIC_PROJECT_ID,LAMATIC_API_KEY&envDescription=Your%20Lamatic%20Generation%20keys%20are%20required.&envLink=https://lamatic.ai/templates/agentkits/agentic/agent-kit-generation)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/Lamatic/AgentKit&root-directory=kits/sample/content-generation&env=AGENTIC_GENERATE_CONTENT,LAMATIC_API_URL,LAMATIC_PROJECT_ID,LAMATIC_API_KEY&envDescription=Your%20Lamatic%20Generation%20keys%20are%20required.&envLink=https://lamatic.ai/templates/agentkits/agentic/agent-kit-generation)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@kits/sample/content-generation/README.md` at line 12, The deploy badge in
README.md points to the wrong subdirectory: update the URL query parameter
root-directory in the Vercel button link (the string containing
root-directory=kits/agentic/generation) to
root-directory=kits/sample/content-generation so the badge deploys the correct
kit; ensure the rest of the query (repository-url and
env/envDescription/envLink) remains unchanged and verify the rendered badge link
opens the desired subdirectory.
🧹 Nitpick comments (1)
README.md (1)

131-133: Mention copying from the kit’s .env.example first.

Right now this tells users where to enter values, but not how to get the kit-specific variable list. Since the kits already ship .env.example templates, adding that step would prevent missing or mistyped keys.

Suggested wording
-   - Enter API keys, endpoints, and credentials in `.env` or `.env.local` (based on the selected kit). Setup details are documented in each kit/template `README.md`.
+   - Copy the selected kit’s `.env.example` to `.env` or `.env.local`, then fill in the required API keys, endpoints, and credentials. Setup details are documented in each kit/bundle `README.md`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 131 - 133, Update the "3. **Configure Integrations**"
step in README.md to instruct users to first copy the kit's `.env.example` into
`.env` or `.env.local` before filling values, e.g. "cp .env.example .env" (or
use the equivalent on Windows), and mention that each kit/template ships its own
`.env.example` with the full variable list; reference the existing sentence that
tells users to enter API keys/endpoints so the new line appears directly before
it and prevents missing or mistyped keys.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@kits/embed/sheets/.env.example`:
- Around line 1-4: The .env example uses spaces around the equals sign which
breaks canonical dotenv syntax; update the variables EMBEDDED_SHEETS,
LAMATIC_API_URL, LAMATIC_PROJECT_ID, and LAMATIC_API_KEY to standard KEY="value"
format with no spaces around '=' (e.g., EMBEDDED_SHEETS="EMBEDDED_SHEETS Flow
ID") so the file is safe to source and stops dotenv-linter warnings.

In `@README.md`:
- Around line 124-129: Update the README text that directs users to "/templates"
so it matches the repository structure in this PR by replacing references to
"/templates" with "bundles/..." (or reword to "browse bundles for single-flow
exports") where the example and bullet list mention "/templates"; ensure the
example path and explanatory line that currently reads "/templates" now points
to the correct "bundles" location so users are not sent to a non-existent path.

---

Outside diff comments:
In `@kits/sample/content-generation/README.md`:
- Line 12: The deploy badge in README.md points to the wrong subdirectory:
update the URL query parameter root-directory in the Vercel button link (the
string containing root-directory=kits/agentic/generation) to
root-directory=kits/sample/content-generation so the badge deploys the correct
kit; ensure the rest of the query (repository-url and
env/envDescription/envLink) remains unchanged and verify the rendered badge link
opens the desired subdirectory.

---

Nitpick comments:
In `@README.md`:
- Around line 131-133: Update the "3. **Configure Integrations**" step in
README.md to instruct users to first copy the kit's `.env.example` into `.env`
or `.env.local` before filling values, e.g. "cp .env.example .env" (or use the
equivalent on Windows), and mention that each kit/template ships its own
`.env.example` with the full variable list; reference the existing sentence that
tells users to enter API keys/endpoints so the new line appears directly before
it and prevents missing or mistyped keys.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 129058cb-e115-4b03-b209-81322a6b7cf5

📥 Commits

Reviewing files that changed from the base of the PR and between 994954e and 75c6b69.

📒 Files selected for processing (16)
  • README.md
  • bundles/assistants/config.json
  • bundles/document-parsing/config.json
  • bundles/knowledge-chatbot/config.json
  • bundles/sample/chatbot/config.json
  • bundles/semantic-search/config.json
  • kits/agentic/generation/README.md
  • kits/assistant/grammar-extension/README.md
  • kits/assistant/grammar-extension/config.json
  • kits/automation/blog-automation/.env.example
  • kits/automation/hiring/README.md
  • kits/embed/chat/README.md
  • kits/embed/search/README.md
  • kits/embed/sheets/.env.example
  • kits/embed/sheets/README.md
  • kits/sample/content-generation/README.md

@amanintech
Copy link
Copy Markdown
Member

Good contributions and fixes @amanyadav721 . Thanks for your contributions. Please check out https://lamatic.ai/careers

@amanintech amanintech merged commit 64bbbd0 into Lamatic:main Mar 23, 2026
1 check passed
@amanyadav721
Copy link
Copy Markdown
Contributor Author

amanyadav721 commented Mar 23, 2026 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants