Skip to content

feat(ui): Add FAQ page with styled sections and category navigation #294

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

phiro56
Copy link
Contributor

@phiro56 phiro56 commented Jul 6, 2025

Update FAQ UI

feat(ui): Add FAQ page with styled sections and category navigation

  • Move FAQ content from external source to local repository
  • Create new FAQ template with left sidebar navigation
  • Add styled FAQ sections with collapsible content
  • Implement category-based navigation links
  • Add review notice banner for pages under review
Screenshot 2025-07-24 at 6 12 51 PM

@stockholmux
Copy link
Member

I'll wait to hear about the valkey-doc#329

@stockholmux
Copy link
Member

Looks like we're going to port the FAQ from docs to the website repo.

phiro56 added 2 commits July 24, 2025 16:40
- Create new FAQ template with left sidebar navigation
- Add styled FAQ sections with collapsible content
- Implement category-based navigation links
- Add review notice banner for pages under review

Signed-off-by: Daniel Phillips <[email protected]>
- Move FAQ content from external source to local repository
- Update FAQ styling and layout for better readability

Signed-off-by: Daniel Phillips <[email protected]>
@phiro56 phiro56 force-pushed the feature/blog-new-styling branch from 76ad65f to 1bb87b8 Compare July 24, 2025 22:41
@phiro56
Copy link
Contributor Author

phiro56 commented Jul 25, 2025

@stockholmux latest changes include:

  1. Keep content/topics/faq.md under version control in this repo. FAQ content is now managed locally, tracked by git, and can be edited directly in your main website repo. No more dependency on the remote valkey-doc repo for FAQ content.

  2. Protect Local FAQ from Being Overwritten. By adding a check in build/init-topics-and-clients.sh to skip faq.md, we ensure that the build script will never overwrite your local FAQ when it creates or updates other topic stubs.

Copy link
Member

@stockholmux stockholmux left a comment

Choose a reason for hiding this comment

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

This doesn't seem like an approach that will be easy to update or use.

Can we use a Zola section and page with render = false?

Ideally, each FAQ item is built from it's own markdown file: the question would be a front matter item, and the answer would be the body of the file. The FAQ categories would be a taxonomy.

This would make it easy to update and add more. Once the FAQ is ported over, we can just get rid of the file on valkey-doc

phiro56 added 2 commits July 31, 2025 11:41
- Split FAQ into individual topic files for better organization
- Update templates to support new FAQ structure

Signed-off-by: Daniel Phillips <[email protected]>
@phiro56
Copy link
Contributor Author

phiro56 commented Jul 31, 2025

@stockholmux
New location: content/topics/faq/
Index file: content/topics/faq/_index.md - serves as the section container with render = false
Individual Q&A files: Each question gets its own markdown file in the faq/ subdirectory
HTML: Removed from md files

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.

2 participants