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.