docs: source-align the Echo website in echox
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- go
研究方向
Start with draft PR #447 and the documented CI checks, then review the remaining authored behavior and security claims against both pinned Echo revisions. Native speakers should assess the new localized task-page wording, while a browser preview should cover mobile usability, accessibility, and Core Web Vitals. Done means the remaining review decisions and any cross-repository gate ownership are recorded before publication.
由索引模型根據 Issue 內容生成。
描述
Goal
Make the published Echo documentation accurate against the exact Echo revision it describes while keeping the Astro/Starlight website and all documentation-only files in labstack/echox. Preserve live URLs and important anchors, five locales, cookbook pages, search, Ask AI, and independent website publishing.
This issue was transferred from labstack/echo#3116 after repository ownership was clarified. Echo's API source remains in Echo. Runnable docs examples, reference extraction, authored pages, translations, site code, and deployment belong in echox.
Source revision contract
- Record the Echo commit for each published reference; show it next to generated API facts.
- Compile documentation examples against the recorded Echo source and import the same files into pages.
- Extract facts source can establish: exported config fields and types, deprecations, signatures, and source links. A reviewed baseline must make API drift fail CI with a readable diff.
- Author and review defaults, conditional behavior, security guidance, tutorials, and translations. Extraction alone cannot establish those claims.
- Identify the owning module and version for external middleware.
Implemented in draft PR #447
- Stable and next builds use separate pinned Echo revisions, visible version switches, and separate Pagefind indexes. Existing site URLs remain at the stable root; next lives under
/next/. - Source-backed tables cover all 22 core middleware configs across 20 pages and all five locales. JWT, Prometheus, and OpenTelemetry reference facts come from their pinned module releases.
- Request Logger and Static import the same runnable Go files that the build compiles against the Echo source. These pages correct the drift from #439.
- A middleware task page in every locale connects common goals to pages, examples, and follow-on guide tasks.
- CI checks source/API baselines, translated section freshness on the new and example pages, 676 routes, internal links and assets, image text, locale coverage, and representative HTML/asset size budgets. Offline link auditing also checks fragments.
- The existing website deployment remains in
echox. Echo cleanup PR labstack/echo#3119 has merged, leaving no documentation-only files in Echo.
Remaining review before publication
- Review authored behavior, default, and security claims against both pinned Echo revisions; API extraction does not establish runtime behavior.
- Have native speakers review newly authored Spanish, Japanese, Portuguese, and Chinese task-page wording. Section hashes detect drift but cannot judge translation quality.
- Measure mobile usability, accessibility, and Core Web Vitals in a browser preview. Current checks cover structural accessibility and static size regressions, not those human/browser measurements.
- Decide with Echo maintainers whether a small Echo-to-echox cross-repository PR gate is warranted and how it selects an
echoxref. The site can already test a proposed Echo checkout withECHO_SOURCE_DIR.
The gomarkdoc --embed/--check trial and its limits remain in this repository. Package-wide output is too broad for individual middleware pages, and generated fields do not establish runtime defaults or security behavior.
Acceptance criteria
- Existing live URLs and important anchors resolve; all five locales and cookbook pages remain available.
- Removing or renaming a core middleware API field fails the docs compatibility check until the baseline and affected pages are reviewed.
- Cookbook, runnable reference examples, and site build pass against their recorded Echo revisions. Published references visibly identify those revisions.
- Runtime claims, security notes, translations, and external middleware facts have explicit review and ownership paths.
- Reader-task, accessibility, performance, and URL checks are compared with the recorded baseline before publication.
- 主要語言
- MDX
- 星號
- 440
- 分支
- 298
- 平均合併
- 17 分鐘
- 30 天內合併 PR
- 13
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
labstack/echox 的其他 Issue
-
難度 1/5 1 小時以內 新手友好度 88/100
維護者通常 1 天內回覆
-
enhancement
難度 5/5 一週以上 新手友好度 30/100
維護者通常 1 天內回覆
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 83/100
awslabs/visual-asset-management-system#1278 ·
維護者通常 1 天內回覆
-
💬assessment
難度 2/5 1-3 小時 新手友好度 74/100
db-ux-design-system/core-web#8795 ·
維護者通常 1 天內回覆
-
a10y ai-driven-qa bug claude Minor
難度 2/5 1-3 小時 新手友好度 76/100
linagora/twake-mail-admin#607 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
-
難度 2/5 1-3 小時 新手友好度 62/100
mitchib1440/SpeakThat#163 · 1 則留言 ·