Skip to content

docs: add English Communication (Sem 1) documentation and quiz#173

Open
Kartikeyji17 wants to merge 1 commit into
pushkarscripts:mainfrom
Kartikeyji17:docs/english-communication-sem1
Open

docs: add English Communication (Sem 1) documentation and quiz#173
Kartikeyji17 wants to merge 1 commit into
pushkarscripts:mainfrom
Kartikeyji17:docs/english-communication-sem1

Conversation

@Kartikeyji17
Copy link
Copy Markdown

Related Issue

Fixes #122


Description

Describe the changes made in this PR.

Added complete beginner-friendly documentation for English Communication (Sem 1) which was previously marked as "Coming Soon" on the platform.

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • UI/UX improvement
  • Refactor

Screenshots / Demo

Screenshot 2026-05-25 084023 Screenshot 2026-05-25 084039 Screenshot 2026-05-25 084103 Screenshot 2026-05-25 084118 Screenshot 2026-05-25 084151 Screenshot 2026-05-25 084243 Screenshot 2026-05-25 084306

How Has This Been Tested?

Describe how you tested your changes locally.

Tested locally using npm run dev. All 7 chapters load correctly, sidebar navigation works, and the quiz functions with 22 questions and instant feedback.

Checklist

  • My code follows the project structure and conventions
  • I have tested the changes locally
  • I have linked the related issue properly
  • I have added screenshots where applicable
  • No existing functionality was broken

AI Usage

  • I have not used AI tools for this contribution

  • I have used AI tools (ChatGPT, Copilot, Claude, etc.) and I have reviewed, verified, and understood all generated code/content before submitting this PR

If AI tools were used, briefly explain how:

Used AI for documentation drafting, content structuring, and code scaffolding. All content was reviewed, verified for accuracy, and tested locally before submission.


Additional Notes

  • Added "ec" to the available subjects list in subjects.tsx so the subject is now clickable on the homepage
  • Added a 22-question quiz to quizData.ts for the subject

Copilot AI review requested due to automatic review settings May 25, 2026 03:18
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 25, 2026

@Kartikeyji17 is attempting to deploy a commit to the PushkarScripts Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds Semester 1 “English Communication” subject pages and quiz content, integrating it into the existing subject/quiz navigation.

Changes:

  • Added a new quiz dataset entry for “English Communication” (slug ec).
  • Introduced a new /app/sem1/ec section with layout, sidebar navigation, and chapter content pages.
  • Registered ec in the subject list so it appears as an available subject.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
lib/quizData.ts Adds the “English Communication” quiz questions and metadata (slug ec).
app/sem1/ec/page.tsx Adds a landing page for the English Communication section.
app/sem1/ec/layout.tsx Introduces a dedicated layout with Navbar + Sidebar for /sem1/ec.
app/sem1/ec/[chapter]/page.tsx Implements dynamic chapter rendering with prev/next navigation.
app/sem1/ec/components/sidebar.tsx Adds chapter list + “Take the Quiz” link in a responsive sidebar.
app/sem1/ec/content/chapter0.tsx Adds course outline content.
app/sem1/ec/content/chapter1.tsx Adds “Basics of Communication” content.
app/sem1/ec/content/chapter2.tsx Adds “Written Communication” content.
app/sem1/ec/content/chapter3.tsx Adds “Verbal & Non-Verbal Communication” content.
app/sem1/ec/content/chapter4.tsx Adds “Reading Comprehension” content.
app/sem1/ec/content/chapter5.tsx Adds “Grammar Essentials” content.
app/sem1/ec/content/chapter6.tsx Adds “Presentation & Interview Skills” content.
app/components/subjects.tsx Adds ec to the available subject codes list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread app/sem1/ec/layout.tsx
Comment on lines +3 to +9
import Navbar from "../../components/navbar";
import Sidebar from "./components/sidebar";
export const metadata = {
title: "English Communication | openCSE",
description: "English Communication documentation for Semester 1 CSE students.",
};
export default function Sem1EcLayout({ children }: { children: React.ReactNode }) {
Comment on lines +28 to +33
type ChapterProps = {
params: Promise<{ chapter: string }>;
};

export default async function ChapterPage({ params }: ChapterProps) {
const { chapter: chapterId } = await params;
Comment on lines +118 to +125
<button
onClick={() => setOpen(!open)}
className="toggle-sidebar shrink-0 pointer-events-auto bg-[#ffdda7] h-full w-[50px] text-[#1B0D00] text-center font-semibold text-2xl border-l-4 rounded-r-2xl border-[#1B0D00] flex items-center justify-center transition-all duration-300 md:shadow-none"
style={{
fontFamily: "Rockwell, Serif, serif",
boxShadow: open ? "4px 0 15px rgba(0,0,0,0.1)" : "none",
}}
>
Comment on lines +25 to +33
const chapters = [
{ id: "ch0", title: "Course Outline" },
{ id: "ch1", title: "Basics of Communication" },
{ id: "ch2", title: "Written Communication" },
{ id: "ch3", title: "Verbal & Non-Verbal Communication" },
{ id: "ch4", title: "Reading Comprehension" },
{ id: "ch5", title: "Grammar Essentials" },
{ id: "ch6", title: "Presentation & Interview Skills" },
];

// Available subjects
const available = ["ep", "c", "em1", "em2", "oops", "dsc", "coa", "os", "ml", "dops", "cd", "cle"];
const available = ["ep", "c", "em1", "em2", "oops", "dsc", "coa", "os", "ml", "dops", "cd", "cle","ec"];
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.

[DOCS] Add Documentation for English Communication (Sem 1)

2 participants