docs: add FAQ/recipes section#4555
Open
maliktafheem wants to merge 1 commit intolitestar-org:mainfrom
Open
Conversation
Establishes a new FAQ section in docs/topics/ to answer common questions. Initial content includes how to enable stack trace visibility using debug mode. Fixes litestar-org#3450 Signed-off-by: Malik Tafheem <maliktafheem10@gmail.com>
github-actions
bot
added
area/docs
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4555 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a new FAQ & Common Recipes section to the documentation to address common questions from users.
docs/topics/faq.rstwith initial FAQ contentdocs/topics/index.rstInitial Content
The first FAQ entry addresses a common question: "How do I see stack traces in error responses?"
This covers:
debug=Truein the Litestar app constructor--debugCLI flagFuture Expansion
The FAQ section is designed to be expanded over time with additional common questions and recipes. The structure is in place for contributors to easily add more entries.
Fixes #3450