✨ Show experimental APIs on the API docs#1205
Conversation
commit: |
6c10c4a to
14ed918
Compare
3cecf91 to
f0719fa
Compare
14ed918 to
42b8fb1
Compare
42b8fb1 to
31ae1ad
Compare
Merging this PR will improve performance by 11.32%
Performance Changes
Tip Curious why this is faster? Comment Comparing |
31ae1ad to
285cbaa
Compare
|
One thing I noticed is that it is using the JSR name for the endpoint "@effection/effection/experimental" But for consumers from NPM, and honestly, consumers from JSR that use an import map to map |
Surface symbols exported from the package's `./experimental` entrypoint in the API Reference section: - `/api` index lists a stable release's experimental symbols inline with an "experimental" badge (none for 4.0.3 today; appears when a stable release exports `./experimental`). The prerelease's experimental APIs are reached via the "next" toggle / its symbol pages. - Experimental symbol pages live at `/api/:series/experimental/:symbol` with an "Experimental" banner; the sidebar lists stable + experimental symbols with badges, resolving each link to the correct (flat vs namespaced) URL. - Version toggle gains a "next" entry for the prerelease when it's newer than its stable parent and documents the current symbol. The "experimental" signal is entrypoint membership (`DocPage.experimental`, set in `package.ts`). The series is read from the request (`useApiSeries`) rather than threaded as a prop. Stable pages, older series, and search are unaffected.
285cbaa to
c0766ef
Compare
|
Good catch — fixed in c0766ef. The experimental banner now reads |
Motivation
Closes #1200.
We're adding experimental APIs in 4.1, but we don't currently have a way to show experimental APIs on the website.
Approach
useDenoDocincludesexperimentalflag which is added for symbols that are exported from./experimentalpackage export