Skip to content

feat(about): add an FAQ page under About Us - #1643

Draft
matbmoser wants to merge 3 commits into
mainfrom
claude/add-faq-page-under-about
Draft

matbmoser wants to merge 3 commits into
mainfrom
claude/add-faq-page-under-about

Conversation

@matbmoser

Copy link
Copy Markdown
Contributor
KIT Master Builder avatar KIT Master Builder 🏗️
AI agent for Eclipse Tractus-X KITs · what is this?
Posted through @matbmoser's account at their request. I answer from the KITs, TRGs and files I opened, not from memory.

👋 Hi! I'm the KIT Master Builder — your Eclipse Tractus-X KIT architect.

Here's what I did in this PR:

I added a separate FAQ page to the About Us section, at /AboutUs/faq. It has 19 questions in three topics: About the project, Technology & KITs and Community & contributing. It uses the same hero and design tokens as the About Us page, so it looks like part of that section. Every answer comes from a page of this site (About Us, Getting Started, the project roles, the release process, the KIT Lifecycle, SECURITY.md, and others) and links to it, so the FAQ stays short and points readers to the full explanation.

✅ What's included

  • data/tractusxFaq.js (new): the questions and answers. Answers are plain strings with [text](url) links. The file header explains how to add a question.
  • src/components/FaqAccordion/ (new): the accordion, built on native <details>/<summary>. Keyboard and screen-reader support come from the browser, and the answers are in the server-rendered HTML. Each question has a deep link (/AboutUs/faq#what-is-a-kit opens it). richText.js only turns site paths, https:// and mailto: URLs into links.
  • src/pages/AboutUs/faq/ (new): the page, with:
    • a search box (shareable as ?q=) and Expand all / Collapse all;
    • a sticky topic list, which becomes scrollable chips on small screens;
    • an empty state, and a Still have a question? section with Matrix, the mailing list and the open meetings;
    • FAQPage structured data (JSON-LD).
  • src/components/AboutUsHeader/index.js: optional title, subtitle and breadcrumb props. The defaults keep the About Us page exactly as it is.
  • docusaurus.config.js: About Us in the navbar is now a dropdown with About Eclipse Tractus-X and FAQ. Clicking the label still opens /AboutUs.
  • Decisions:
    • I used the About Us styling (light/dark tokens, orange accents) rather than the dark hero of feat: add dedicated Tractus-X Accelerator page #1619's Accelerator page, because the FAQ sits inside About Us.
    • I didn't reuse the old FAQsComponent / utils/faqsContent.js: nothing imports them, and their text is outdated ("first three lighthouse KITs", "Catena-X KITs"). I left them in place. Removing them can be a follow-up.

🔍 How to review

  • Read the answers in data/tractusxFaq.js; that's where review matters most. Please check especially Who governs the project?, Is Eclipse Tractus-X only for the automotive industry? and Who can contribute?.
  • Run npm start, then open /AboutUs/faq, /AboutUs/faq#report-a-vulnerability and /AboutUs/faq?q=committer, in light and dark mode.
  • If feat: add dedicated Tractus-X Accelerator page #1619 is merged first, the Accelerator page could get a third entry in the About Us dropdown.

📋 Compliance check

  • This PR doesn't touch any KIT files, so I kept to general quality and legal checks.
  • TRG 7.07: every new .js file has the Apache-2.0 header, and the new CSS files use the short SPDX header like AboutUsContent/styles.module.css. There are no new images or Markdown files.
  • No new dependencies. Icons come from the existing @mui/icons-material.
  • No broken links: onBrokenLinks and onBrokenAnchors are throw, and the page registers its topic and question anchors.

Thanks for trusting me to build this! 🏗️ Feel free to ask me anything in the comments.

How I checked this (and how you can reproduce it)

Checked on claude/add-faq-page-under-about:

npm run build      # [SUCCESS] Generated static files in "build" (onBrokenLinks/onBrokenAnchors: throw)
npm run lint-doc   # Summary: 0 error(s)
npm run lint-kits  # Summary: 0 error(s)
  • Build: it ran on the first commit (fcd0ac62). The two later commits only change page logic (?q=) and CSS, with no links or anchors. The build's minifier warnings are all on an existing page (/docs/oss/howto-xray), and the image-size warnings are about existing KIT SVGs.

  • Data and link parser: I checked them with a throwaway Node script: unique kebab-case ids, every question ends with "?", only allowed links, and javascript: and //host links stay plain text. Result: 3 topics and 19 questions, all checks pass.

  • Screenshots: with npm start, I took screenshots at 1440×900 and 390×844 of:

    • the page;
    • a deep-linked open answer;
    • a search and an empty search;
    • light mode (?docusaurus-theme=light);
    • the unchanged About Us page.

    They found a horizontal overflow on phones, which I fixed in ba5125bc.

  • Not captured: the open navbar dropdown, because the screenshot CLI can't hover.

What I verified and what I only infer: Each answer restates a page of this repo or of the Eclipse Foundation that I read. The answers are a summary, so please confirm the wording, especially on governance and on the industries involved.

— KIT Master Builder 🏗️

Prepared by Claude (Daily Focus) for review.

🤖 Generated with Claude Code

Adds /AboutUs/faq with 19 questions in three topics (the project, technology and KITs, community and contributing). The answers come from the site's own pages and link to them.

- data/tractusxFaq.js holds the questions; answers are strings with [text](url) links
- FaqAccordion renders them as native <details> accordions with deep links (#question-id)
- the page adds search, topic navigation, expand/collapse all, a contact section and FAQPage structured data
- AboutUsHeader takes an optional title, subtitle and breadcrumb, so the FAQ uses the same hero
- the About Us navbar item becomes a dropdown with About Eclipse Tractus-X and FAQ

Assisted-By: Claude Opus 5.5 <noreply@anthropic.com>
The search box reads ?q= on load and keeps it in the URL while typing.

Assisted-By: Claude Opus 5.5 <noreply@anthropic.com>
The topic chips row widened the grid column, and the visually hidden question counts in the chips sat outside the scroll area. Both pushed the page to 737px on a 390px screen. The column is now minmax(0, 1fr) and each chip is positioned.

Assisted-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Pull request preview

The website was built from this pull request and is available here:

🌐 Preview URL: https://eclipse-tractusx.github.io/pr/1643/

This comment is updated automatically on every push. The preview is removed once the pull request is closed.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

1 participant