Rebuild FAQs under Help and Support in Laravel #69

New issue

Open

opened 2024-08-14 14:34:22 -05:00 by jimmyb · 0 comments

jimmyb commented

2024-08-14 14:34:22 -05:00

Owner

Copy link

The FAQ page needs to be rebuilt in Laravel so visitors can find common MyVideoGameList help content from the Help/Support section.

The current Laravel checkout has Support sidebar links for /support, /support/knowledge-base, and /support/contact-us, but no FAQ route or FAQ page appears to be wired up yet. The old issue points to an archived /faqs snapshot as the source for legacy FAQ content. This issue tracks rebuilding the FAQ page, placing it in the Support navigation, and verifying the page with feature tests.

Scope

Public FAQ page under the Help/Support section.
Legacy FAQ content from the archived /faqs page where still accurate.
Support sidebar/navigation link and active state.
Static FAQ rendering unless a separate admin-managed FAQ feature is explicitly added later.
Light/dark-mode styling consistent with existing Laravel/Tailwind site pages.

Acceptance Criteria

A public FAQ page renders successfully for guests and authenticated users.
The FAQ page is reachable from the Support navigation.
The Support navigation marks FAQs active when viewing the FAQ page.
FAQ content is grouped into clear question/answer sections.
Legacy FAQ content from the archived /faqs page is reviewed before being copied, rewritten, or omitted.
Outdated FAQ answers are updated to match the rebuilt Laravel app behavior.
Links inside FAQ answers use current routes or current external support/community URLs.
Empty, broken, placeholder, or “coming soon” FAQ content is not shipped.
The page uses the existing site layout and supports light/dark mode.
The old /faqs path redirects to or renders the canonical FAQ page if a new /support/faqs route is chosen.

Test Coverage Required

Feature tests confirming guests and authenticated users can view the FAQ page.
Feature tests confirming the Support navigation contains the FAQ link and active state.
Feature test confirming /faqs compatibility behavior if the canonical route is /support/faqs.
Regression tests confirming key FAQ headings/questions render.
Regression tests confirming FAQ links point to current internal routes or approved external URLs.
Tests should use Pest and focused feature coverage.
Run the focused affected tests, then run vendor/bin/pint --dirty before closing the issue.

Progress Checklist

Support section exists in the sidebar
Support overview, knowledge base, and contact links are reserved in navigation
Review archived /faqs content for still-current FAQ entries
Choose and add canonical FAQ route
Add /faqs redirect or compatibility route if needed
Build the FAQ page using existing site layout patterns
Add FAQ link and active state to Support navigation
Replace outdated legacy FAQ answers with current Laravel-site behavior
Add tests for rendering, navigation, active state, compatibility route, and FAQ content
Confirm the FAQ page matches expected Help/Support coverage

The FAQ page needs to be rebuilt in Laravel so visitors can find common MyVideoGameList help content from the Help/Support section. The current Laravel checkout has Support sidebar links for `/support`, `/support/knowledge-base`, and `/support/contact-us`, but no FAQ route or FAQ page appears to be wired up yet. The old issue points to an archived `/faqs` snapshot as the source for legacy FAQ content. This issue tracks rebuilding the FAQ page, placing it in the Support navigation, and verifying the page with feature tests. ## Scope - Public FAQ page under the Help/Support section. - Legacy FAQ content from the archived `/faqs` page where still accurate. - Support sidebar/navigation link and active state. - Static FAQ rendering unless a separate admin-managed FAQ feature is explicitly added later. - Light/dark-mode styling consistent with existing Laravel/Tailwind site pages. ## Acceptance Criteria - A public FAQ page renders successfully for guests and authenticated users. - The FAQ page is reachable from the Support navigation. - The Support navigation marks FAQs active when viewing the FAQ page. - FAQ content is grouped into clear question/answer sections. - Legacy FAQ content from the archived `/faqs` page is reviewed before being copied, rewritten, or omitted. - Outdated FAQ answers are updated to match the rebuilt Laravel app behavior. - Links inside FAQ answers use current routes or current external support/community URLs. - Empty, broken, placeholder, or “coming soon” FAQ content is not shipped. - The page uses the existing site layout and supports light/dark mode. - The old `/faqs` path redirects to or renders the canonical FAQ page if a new `/support/faqs` route is chosen. ## Test Coverage Required - Feature tests confirming guests and authenticated users can view the FAQ page. - Feature tests confirming the Support navigation contains the FAQ link and active state. - Feature test confirming `/faqs` compatibility behavior if the canonical route is `/support/faqs`. - Regression tests confirming key FAQ headings/questions render. - Regression tests confirming FAQ links point to current internal routes or approved external URLs. - Tests should use Pest and focused feature coverage. - Run the focused affected tests, then run `vendor/bin/pint --dirty` before closing the issue. ## Progress Checklist - [x] Support section exists in the sidebar - [x] Support overview, knowledge base, and contact links are reserved in navigation - [ ] Review archived `/faqs` content for still-current FAQ entries - [ ] Choose and add canonical FAQ route - [ ] Add `/faqs` redirect or compatibility route if needed - [ ] Build the FAQ page using existing site layout patterns - [ ] Add FAQ link and active state to Support navigation - [ ] Replace outdated legacy FAQ answers with current Laravel-site behavior - [ ] Add tests for rendering, navigation, active state, compatibility route, and FAQ content - [ ] Confirm the FAQ page matches expected Help/Support coverage

jimmyb added the

component: web design

labels

2024-08-14 14:34:22 -05:00

jimmyb added this to the Laravel 13 + TailwindCSS project

2024-08-14 14:34:22 -05:00