litestar-org/litestar

Docs: Add common recipes/FAQ section

Open

#3,450 opened on Apr 29, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (8,243 stars) (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Description

Reported by

Coffee in Discord: Unable to see stack trace inside my routes

Description

we need a sticky, or FAQ or something

MCVE

User asked in discord how to enable visibility into stacktraces, is a frequently asked question.

Logs

N/A

Litestar Version

All

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Litestarability to write Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue asks for a FAQ or recipes section in the Litestar docs. Start by examining the existing documentation structure, likely in the 'docs/' directory. Look at how other sections are organized (e.g., 'usage/') and find the main index or sidebar configuration. The goal is to create a new page or section with common questions and answers, such as enabling stack traces. There are no linked PRs or comments indicating blocked work, so it is open for contribution.