Skip to content

README: deep polish for SEO/GEO + verified accuracy#13

Merged
simongonzalezdc merged 1 commit into
mainfrom
readme-polish
Jun 3, 2026
Merged

README: deep polish for SEO/GEO + verified accuracy#13
simongonzalezdc merged 1 commit into
mainfrom
readme-polish

Conversation

@simongonzalezdc
Copy link
Copy Markdown
Owner

README deep polish — SEO + GEO + accuracy

Restructures the README for human readers, search engines, and LLM summarization (GEO), with every command verified against the actual project files. No code changed — only README.md.

What changed:

  • Clear one-line value proposition (what it does + who its for)
  • Plain, literal What it is section (good for LLM summarization)
  • Verified install / quick-start commands (checked against the real manifests and scripts)
  • Concrete Usage example and a Why / how it works design note
  • A Best-fit searches keyword line (SEO/GEO)
  • Links section back to kyanitelabs.tech and sibling KyaniteLabs repos

🤖 Generated with Claude Code

Restructure README to a clear value-prop + What-it-is + verified Quick start
+ Usage + how-it-works + best-fit search keywords + Links (kyanitelabs.tech and
sibling repos). Commands verified against the actual project files; no code changed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ddad110b1a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
# 3. In a second terminal, start the frontend (Next.js)
cd caedo-web
npm install
npm run dev # serves on http://localhost:3002 by default
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Pass the frontend port in the quickstart

When a fresh user follows this quickstart, npm run dev runs next dev without --port or a shell PORT, so Next starts on its documented default port 3000; PORT=3002 in the copied root .env does not affect server boot. That leaves the README pointing users at 3002 while the repo's own smoke test checks http://localhost:3002 and suggests PORT=3002 npm run dev, so the documented install can appear broken even though the app is running on 3000.

Useful? React with 👍 / 👎.

@simongonzalezdc simongonzalezdc merged commit d3958b5 into main Jun 3, 2026
2 checks passed
@simongonzalezdc simongonzalezdc deleted the readme-polish branch June 3, 2026 03:06
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.

1 participant