litestar-org/litestar

Docs: Add common recipes/FAQ section

Open

#3,450 创建于 2024年4月29日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (8,243 star) (550 fork)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

描述

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

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic knowledge of Litestarability to write Markdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
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.