Skip to content

docs: update AGENTS.md and README.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
onerandomdevv merged 3 commits into from
May 8, 2026
Merged

docs: update AGENTS.md and README.md #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44ca761
docs: update AGENTS.md and README.md
onerandomdevv May 7, 2026
fd1cee1
chore: restore .gitignore
onerandomdevv May 7, 2026
6aa9261
merge: resolve conflicts with origin/dev
Copilot May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 104 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,7 @@ export default async function Page({
24. Never install icon libraries — use shared icons.tsx with raw SVG paths
25. Always await params and searchParams in dynamic route pages (Next.js 15)
26. seed scripts go in scripts/ folder and are gitignored — never commit them
27. Mobile-first responsive design always. Use Tailwind breakpoints in this order: base (mobile) → md (tablet 768px) → lg (desktop 1024px). Never design desktop-first and patch mobile after.

---

Expand Down Expand Up @@ -884,4 +885,106 @@ export async function GET() {

---

*Last updated: May 2026*
## 21. Responsive Design Rules

### Core principle
**Mobile-first always.** Every component is designed for mobile (375px) first, then enhanced for larger screens using Tailwind breakpoints. Never write desktop styles first and try to patch mobile after.

### Breakpoints
```
base → 0px+ mobile phones (375px target)
sm → 640px+ large phones / small tablets (use sparingly)
md → 768px+ tablets
lg → 1024px+ desktop (most layout changes happen here)
xl → 1280px+ large desktop (use sparingly)
```
Comment on lines +894 to +900
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 7, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language identifiers to fenced code blocks (MD040).

These blocks currently use plain triple backticks without a language, which triggers markdownlint warnings and can break docs lint gates.

🧹 Suggested fix pattern 
-```
+```text
 base  → 0px+     mobile phones (375px target)
 sm    → 640px+   large phones / small tablets (use sparingly)
 ...
-```
+```

Apply the same text language tag to each fenced block listed above.

Also applies to: 905-909, 911-915, 917-921, 923-929, 931-935, 937-941, 943-947, 950-954, 956-960, 962-968, 970-975

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 894-894: 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 `@AGENTS.md` around lines 894 - 900, Several fenced code blocks in AGENTS.md
are missing language identifiers which triggers markdownlint MD040; update each
triple-backtick block (the ones showing breakpoints like the "base → 0px+" lines
and the other ranges noted) to use a language tag (use "text") immediately after
the opening ``` so they become ```text, ensuring every fenced block in the
listed ranges (and any similar plain ``` blocks) is updated consistently; search
for the exact triple-backtick blocks that contain the breakpoint tables or plain
text examples and add the "text" identifier to each opening fence.


### Layout rules per section

**Navbar:**
```
mobile: hamburger menu, logo left, menu button right
lg: full nav links visible, logo left, CTA button right
```

**Hero section:**
```
mobile: single column, text stacked, Kody mascot hidden
lg: two columns — text left (flex-1), Kody right (w-80)
```

**Products section:**
```
mobile: single column, full width cards
lg: max-w-xl cards, left-aligned — do not stretch to full width
```

**Latest Releases & Recognition:**
```
mobile: grid-cols-1 (single column)
md: grid-cols-2
lg: grid-cols-3
gap: gap-6 at all breakpoints
```

**About page — two-column sections:**
```
mobile: stacked — heading above, body below
lg: flex-row — heading left (w-1/3), body right (flex-1)
```

**Team section (home page):**
```
mobile: grid-cols-1
md: grid-cols-3
```

**Team page (/team):**
```
mobile: grid-cols-1
md: grid-cols-2
lg: grid-cols-3
```

**Contact page:**
```
mobile: stacked — info above, form below
lg: two columns — info left (w-1/3), form right (flex-1)
```

**Footer:**
```
mobile: stacked — logo+tagline, then nav columns, then bottom bar
lg: logo+tagline left, nav columns right, bottom bar as row
```

### Typography scaling
```
H1 hero: text-4xl md:text-5xl lg:text-7xl
H2 section: text-2xl md:text-3xl lg:text-[40px]
H3: text-xl md:text-2xl
Body: text-base (16px) — never scale down on mobile
```

### What hides or shows at different breakpoints
```
Kody mascot in Hero: hidden on mobile, block on lg
Full nav links: hidden on mobile, flex on lg
Hamburger menu: flex on mobile, hidden on lg
Two-column layouts: stack on mobile, side-by-side on lg
```

### Testing checklist
Before committing any visual design work, test at these widths:
- 375px — iPhone SE (smallest target)
- 390px — iPhone 14
- 768px — iPad portrait
- 1024px — iPad landscape / small desktop
- 1280px — standard desktop
- 1440px — large desktop

Use browser DevTools responsive mode. Never ship a change that breaks any of these widths.

---

*Last updated: May 2026*
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

Official company website and internal CMS for **CODEDDEVS TECHNOLOGY LTD**.

This site presents CODEDDEVS as a product-driven technology company building AI-first software for African markets. The public site is aimed at investors, press, and partners. The admin dashboard is used to manage products, updates, team members, careers, messages, applications, and uploaded media.
- **Live:** codeddevs.com (pending)
- **Framework:** Next.js 15, App Router, TypeScript
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 7, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Next.js version inconsistency in the documentation.

Line 6 states "Next.js 15" but line 20 (in the Tech Stack section) still states "Next.js 14". The README now contains contradictory framework version information.

🔧 Fix the version inconsistency

Update line 20 to match:

-- **Framework:** Next.js 14, App Router, TypeScript
+- **Framework:** Next.js 15, App Router, TypeScript
🤖 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 6, The README has inconsistent Next.js version mentions
(line 6 says "Next.js 15" while the Tech Stack still says "Next.js 14"); update
the Tech Stack entry that currently reads "Next.js 14" to "Next.js 15" so both
references match, ensuring any other occurrences of "Next.js 14" in the README
are changed to "Next.js 15" (search for the string "Next.js 14" and replace it
with "Next.js 15").

Copy link
Copy Markdown
Contributor Author

@onerandomdevv onerandomdevv May 8, 2026

Choose a reason for hiding this comment

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

it's actually NEXT.js 15, that is the tech stack

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 8, 2026

Choose a reason for hiding this comment

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

@onerandomdevv, agreed — Next.js 15 is correct! That's exactly what my comment is flagging: the newly added line 6 correctly says Next.js 15, but the Tech Stack section at line 20 still has the old value "Next.js 14". You'll need to update that line too so both references are consistent:

- - **Framework:** Next.js 14, App Router, TypeScript
+ - **Framework:** Next.js 15, App Router, TypeScript

( •ᴗ• )っ

- **Runtime:** React 19
- **Tech:** Tailwind, Drizzle ORM, Neon PostgreSQL
- **Audience:** Investors, press, and partners
- This site presents CODEDDEVS as a product-driven technology company building AI-first software for African markets. The public site is aimed at investors, press, and partners. The admin dashboard is used to manage products, updates, team members, careers, messages, applications, and uploaded media.

- **Live URL:** https://codeddevs.com
- **Company:** CODEDDEVS TECHNOLOGY LTD
Expand Down Expand Up @@ -245,4 +250,3 @@ NEXTAUTH_URL=https://codeddevs.com

CODEDDEVS TECHNOLOGY LTD
codeddevs.team@gmail.com

Loading