Skip to content

docs: source-align stable and next Echo website - #447

Merged
vishr merged 5 commits into
masterfrom
docs/source-aligned-reference
Sep 27, 2026
Merged

vishr merged 5 commits into
masterfrom
docs/source-aligned-reference

Conversation

@vishr

@vishr vishr commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Build stable (/) and next (/next/) documentation from separately pinned Echo revisions, with separate search indexes and visible source/version switches. Keep the website and documentation tooling in echox; Echo itself remains the API source.

  • Extract config fields, types, deprecations, signatures, and line links from the pinned Echo revisions. Cover all 22 core middleware config types across 20 pages and all five locales.
  • Extract JWT, Prometheus, and OpenTelemetry reference facts from their own pinned module releases. Show the owning module and version on each page.
  • Compile the exact Request Logger and Static example files used by the docs against the pinned Echo source. Keep behavior, defaults, security advice, and task guidance as authored prose.
  • Add a middleware task page in every locale, plus route/anchor, locale, image text, search asset, and static size checks. Keep existing cookbook and guide routes and redirects.
  • Track English and localized edits by section for the new task page and the two reviewed example pages. A stale section now fails the site build; matching hashes do not certify prose quality.

Verification

  • go test ./... in the repository root: passed.
  • npm run build: passed for stable and next, including source/external API baselines, example compilation, translation freshness, 676 routes, 59,608 internal links/assets, and representative HTML/asset size budgets.
  • Offline lychee audit with fragments over the combined site: 67,998 links, 0 errors.
  • git diff --check: passed.

Review focus

Please review the authored task guidance and localized wording, and check behavior explanations against both pinned Echo revisions. The extractor establishes API facts, not runtime defaults or security behavior. Static size checks are regression budgets; browser Core Web Vitals and a native-speaker review are separate quality checks before publishing.

Tracks #448. Echo cleanup PR labstack/echo#3119 has already merged. The Echo-side cross-repository gate remains a separate maintainer decision.

vishr added a commit to labstack/echo that referenced this pull request Sep 27, 2026
Reverts the documentation files added by #3117. The examples and source reference now live in labstack/echox#447.
@vishr vishr changed the title docs: source-align Request Logger and Static in echox docs: source-align stable and next Echo website Sep 27, 2026
@vishr
vishr marked this pull request as ready for review September 27, 2026 23:58
@vishr
vishr merged commit 7987954 into master Sep 27, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant