Update FAQ #329
Open
Update FAQ #329
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update FAQ Q&A - Add Zola Shortcodes to section out categories Signed-off-by: Daniel Phillips <[email protected]>
|
@zuiderkwast How does this affect the generation of man pages? I see it has some template tags in it. |
|
Yeah, the template tags won't work in man pages. The docs are not only targeting our website so let's not add web templating dependencies. See the readme in this repo. Maybe the FAQ is not needed in man pages and alike? If it's not really documentation (as in user manuals) we could consider moving pages like this out of docs and into the website repo... Otherwise, just drop the template tags. |
|
@zuiderkwast Yep. I think it makes sense to move the FAQ into the website. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Restructure FAQ page with new template system
This PR restructures the FAQ page (
topics/faq.md) to use a new template-based format that provides better organization and improved ui.Template Dependencies
Coordination Required: This PR depends on corresponding valkey-io PR: #294
Template Functions Used:
{% faq_section(class="...") %}- Section wrapper with styling classes{% end %}- Section closing tagNote: The spellcheck warnings for
faq_sectionare expected as this is a custom template function.