kayx23 opened a new pull request, #2144:
URL: https://github.com/apache/apisix-website/pull/2144

   ## Summary
   
   - render the unreleased APISIX Next Admin API with Scalar using the OpenAPI 
document from `apache/apisix:master`
   - extract the existing 3.19 Scalar mounting, toolbar, fallback, and search 
behavior into shared code used by both Astro and Docusaurus
   - publish only the Next OpenAPI asset in this PR; release archives remain 
version-specific follow-up work
   - add immutable fixture checks, canonical-source readiness checks, and 
focused desktop/mobile browser coverage
   
   ## Why this is needed
   
   APISIX 3.19 already renders its Admin API with Scalar through 
apache/apisix-website#2141, but the unreleased Next documentation still uses 
the Markdown page even after the master OpenAPI contract is prepared. This 
leaves the development documentation without the same searchable, downloadable 
API reference that the current release provides.
   
   The renderer is shared rather than copied so the proven 3.19 behavior 
remains the baseline:
   
   - Markdown remains readable without JavaScript and is restored when the 
specification is missing, invalid, times out, loses the network, or cannot load 
Scalar.
   - OpenAPI downloads remain same-origin.
   - Scalar owns the shared search shortcut while the reference is visible.
   - The version picker switches between the current release and Next in 
English and Chinese.
   - Mobile layouts keep the version menu above Scalar's runtime-injected 
header.
   
   ## Dependencies and source ownership
   
   - apache/apisix#14105 prepares the source-verified terminology linked by the 
master contract.
   - apache/apisix#14084 adds the canonical master OpenAPI contract and should 
merge after #14105.
   - Production synchronization reads `apache/apisix@master`; it never reads 
from the contributor fork.
   - Until #14084 merges, the test fixture is pinned to its immutable head 
commit solely to verify byte-for-byte source parity.
   
   The validated Next document contains 47 paths and has SHA-256 
`5f44448f680bbcdd9c1441c490e859af3893df2865f6e2a0c32e2d28cbb1416b`.
   
   ## Validation
   
   - `node --test shared/admin-api-spec.test.mjs scripts/lib/admin-api.test.js` 
— 3 passed
   - fixture parity against apache/apisix#14084 head — 47 paths, byte-for-byte 
match
   - canonical `apache/apisix@master` source-readiness check
   - ESLint on the shared renderer, Playwright configuration, and browser tests
   - Stylelint on the shared toolbar CSS
   - Astro production build — 1,336 pages, English and Chinese sitemaps 
validated
   - Docusaurus production build — English and Chinese archives generated 
successfully
   - combined production-output Playwright suite — 64 passed across desktop and 
mobile Chrome
   - browser coverage includes English and Chinese current/Next rendering, 
downloads, version switching, search ownership, no-JavaScript readability, 
responsive overflow, and six fallback modes
   - `git diff --check`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to