Add Landing Page overview section and improve README formatting for clarity

[Riyanshverma]

Closes #190

📝 Description

This pull request adds a comprehensive "Landing Page Overview" section to the main README, describing the purpose, structure, and key elements of the public landing page. It also improves formatting and clarity throughout the README for better readability and onboarding of new contributors.

🔧 Changes Made

• Added a new "Landing Page Overview" section after the Tech Stack in the README.
• Documented the landing page’s purpose, main sections, and onboarding flow.
• Linked to the relevant frontend files for the landing page implementation.
• Provided local development instructions for the landing page.
• Improved formatting consistency and section clarity in the README.

📷 Screenshots or Visual Changes (if applicable)

N/A (Documentation update only, no UI changes in this PR.)

🤝 Collaboration

Collaborated with: N/A

✅ Checklist

• I have read the contributing guidelines.
• I have added tests that prove my fix is effective or that my feature works.
• I have added necessary documentation (if applicable).
• Any dependent changes have been merged and published in downstream modules.

Summary by CodeRabbit

• Documentation
  • Added comprehensive Landing Page documentation with setup instructions, component overview, and local development guidance
  • Added Data Population section with step-by-step database configuration steps using Supabase
  • Expanded Getting Started section with detailed workflow and deployment instructions
  • Enhanced documentation structure with visual section separators for improved readability

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md receives documentation-only updates including a new Landing Page Overview section describing key elements and local development setup, a Data Population section with database initialization steps, Getting Started workflow expansions with frontend/backend setup guidance, visual separators, and Mermaid workflow diagrams. No code or logic changes.

Changes

Cohort / File(s)

Summary

README Documentation Expansion README.md

Added Landing Page Overview section with description of hero, features grid, integrations, and waitlist form components; included local development instructions. Added Data Population section with Supabase SQL Editor setup steps. Expanded Getting Started section with frontend/backend setup steps, deployment guidance, and Mermaid workflow diagrams for visual process documentation. Added visual separator lines for improved readability.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Focus areas:
  • Verify Landing Page component paths (LandingPage/src/Pages/Landing.tsx, LandingPage/src/components) are accurate and current
  • Confirm Supabase SQL setup instructions and sql.txt file reference are correct and complete
  • Check that frontend/backend setup commands (npm install, npm run dev, etc.) match actual project structure

Possibly related PRs

• Update README.md #81: Also expands README.md with landing page documentation details, setup workflows, and data population guidance.

Suggested labels

documentation

Poem

🐰 Hops through docs with glee,
Landing pages now all can see!
SQL paths and setup flows so clear,
README shines—contributors cheer! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately summarizes the main change: adding a Landing Page overview section and improving README formatting, which aligns directly with the changeset focused on README documentation.
Linked Issues check	✅ Passed	The PR fully addresses all coding-related requirements from issue #190: adds Landing Page Overview section explaining content, purpose, and onboarding flow; links to frontend files; provides local development instructions; improves README formatting.
Out of Scope Changes check	✅ Passed	All changes are directly related to the linked issue #190 objectives. The README additions (Landing Page section, Data Population section, formatting improvements) are within scope and support the documentation improvement goals.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a3be437 and bacb6b1.

📒 Files selected for processing (1)

• README.md (4 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: Saahi30
Repo: AOSSIE-Org/InPactAI PR: 98
File: Frontend/src/pages/CollaborationDetails.tsx:519-521
Timestamp: 2025-07-12T20:28:05.017Z
Learning: In frontend-only commits that use mock data, hardcoded progress values and similar placeholder data are acceptable and intentional. These values serve as placeholders for UI development and will be replaced with dynamic calculations once backend integration occurs.

🔇 Additional comments (4)

README.md (4)

57-57: Verify markdown link paths are correctly formatted and resolve in GitHub.

The file path links at line 57 use relative paths without a standard GitHub URL or relative prefix. Verify that [LandingPage/src/Pages/Landing.tsx](LandingPage/src/Pages/Landing.tsx) and similar links render and navigate correctly when viewed on GitHub. Consider using full GitHub URLs or proper relative path prefixes (e.g., ./LandingPage/src/Pages/Landing.tsx) if links do not resolve.

Also applies to: 58-64

---

60-64: Landing Page local development instructions are clear and actionable.

The npm setup commands are straightforward and follow standard conventions. Assuming the LandingPage directory exists with the expected structure, these instructions should work correctly.

---

29-100: Documentation structure and formatting improvements look good.

The addition of visual separators and the new Landing Page Overview and Data Population sections enhance README clarity and contributor onboarding. The formatting is consistent with the existing style, and the content hierarchy is logical. The descriptions of purpose, key elements, and setup workflows are well-articulated and actionable.

---

227-229: Verify the sql.txt file exists and is accessible to developers.

The Data Population section references opening and copying SQL queries from sql.txt. Ensure this file exists in the project root (or specify the correct relative path) so developers can easily locate and execute the initialization script.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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