feat(api-reference): show External Documentation Object #5623

hanspagel · 2025-05-12T15:06:15Z

Problem

Currently, we don’t render External Documentation Objects. :(

Solution

This PR finally renders them. :)

Fixes #1020

Checklist

I’ve gone through the following:

I’ve added an explanation why this change is needed.
I’ve added a changeset (pnpm changeset).
I’ve added tests for the regression or new feature.
I’ve updated the documentation.

changeset-bot · 2025-05-12T15:06:21Z

🦋 Changeset detected

Latest commit: ba45ba6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 29 packages

Name	Type
@scalar/types	Patch
@scalar/themes	Patch
@scalar/api-reference	Patch
@scalar/docusaurus	Patch
@scalar/nestjs-api-reference	Patch
@scalar/nuxt	Patch
@scalar/api-client-react	Patch
@scalar/api-client	Patch
@scalar/api-reference-react	Patch
@scalar/core	Patch
@scalar/nextjs-openapi	Patch
@scalar/oas-utils	Patch
@scalar/openapi-to-markdown	Patch
@scalar/scripts	Patch
@scalar/snippetz	Patch
@scalar/workspace-store	Patch
@scalar/components	Patch
@scalar/use-codemirror	Patch
scalar-app	Patch
@scalar/aspire	Patch
@scalar/aspnetcore	Patch
@scalarapi/docker-api-reference	Patch
@scalar/fastify-api-reference	Patch
@scalar/nextjs-api-reference	Patch
@scalar/express-api-reference	Patch
@scalar/hono-api-reference	Patch
@scalar/sveltekit	Patch
@scalar/mock-server	Patch
@scalar/postman-to-openapi	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

antlio · 2025-05-29T18:45:28Z

will jump into this once #5706 is in

cameronrohani · 2025-06-10T20:09:45Z

@antlio can you get this one over the finish line?

just vertically stack these links in the introduction section:

and put at the top of endpoint / tag markdowns (but not in the same container as headings)

relativeci · 2025-06-11T08:55:07Z

#11488 Bundle Size — 2.61MiB (+0.62%).

a747b1c(current) vs f62f7f3 main#11483(baseline)

Warning

Bundle contains 3 duplicate packages – View duplicate packages

Bundle metrics

2 changes

1 regression

	Current #11488	Baseline #11483
Initial JS	`2.61MiB`(`+0.62%`)	`2.59MiB`
Initial CSS	`0B`	`0B`
Cache Invalidation	`100%`	`100%`
Chunks	`1`	`1`
Assets	`1`	`1`
Modules	`1754`(`+0.75%`)	`1741`
Duplicate Modules	`0`	`0`
Duplicate Code	`0%`	`0%`
Packages	`170`	`170`
Duplicate Packages	`3`	`3`

Bundle size by type

1 change

1 regression

	Current #11488	Baseline #11483
JS	`2.61MiB` (`+0.62%`)	`2.59MiB`

Bundle analysis report Branch feat/external-docs Project dashboard

^{Generated by RelativeCI Documentation Report issue}

github-actions · 2025-06-11T08:55:31Z

Preview Examples

https://b8ec6157-f8b7-47da-be61-b70ae4c2635f--scalar-deploy-preview.netlify.app

marclave

i don't think we wanna use parsed spec anymore but waiting for @amritk

antlio · 2025-06-11T14:51:15Z

i don't think we wanna use parsed spec anymore but waiting for @amritk

fair i just lazily reused it since it is still heavily present, updated in order to favor store collection

amritk · 2025-06-11T16:41:40Z

Correct, I have removed it from there in my PR. use dreferencedDocument for now until we switch to new store

amritk · 2025-06-11T16:41:58Z

but you don't need to change anything in intro as I have already done it

packages/api-reference/src/features/ExternalDocs/ExternalDocs.vue

amritk · 2025-06-20T16:38:03Z

on you now @marclave

antlio

slick!

Co-authored-by: Amrit Kahlon <amrit@scalar.com>

…l dos component

… of adding props

hanspagel self-assigned this May 12, 2025

hanspagel requested a review from cameronrohani May 12, 2025 15:10

hanspagel force-pushed the feat/external-docs branch from 1dfe985 to 3ecf352 Compare May 16, 2025 09:37

hanspagel assigned cameronrohani and unassigned hanspagel May 23, 2025

antlio force-pushed the feat/external-docs branch from 3ecf352 to 6263256 Compare June 11, 2025 08:51

antlio marked this pull request as ready for review June 11, 2025 08:51

antlio requested review from hwkr, amritk and geoffgscott as code owners June 11, 2025 08:51

antlio force-pushed the feat/external-docs branch 3 times, most recently from 60f5af0 to eb1bca6 Compare June 11, 2025 09:50

marclave self-requested a review June 11, 2025 13:54

marclave requested changes Jun 11, 2025

View reviewed changes

antlio requested a review from marclave June 11, 2025 14:51

antlio force-pushed the feat/external-docs branch from 2e8ffaa to d43735a Compare June 11, 2025 15:13

amritk force-pushed the feat/external-docs branch from d43735a to cf26e10 Compare June 19, 2025 17:10

hanspagel force-pushed the feat/external-docs branch from cf26e10 to a19fa17 Compare June 20, 2025 09:21

amritk approved these changes Jun 20, 2025

View reviewed changes

packages/api-reference/src/features/ExternalDocs/ExternalDocs.vue Outdated Show resolved Hide resolved

hanspagel force-pushed the feat/external-docs branch from c4557cb to 90e1254 Compare June 23, 2025 13:40

hanspagel force-pushed the feat/external-docs branch from 8c93275 to 6ae4acf Compare July 18, 2025 07:44

antlio approved these changes Jul 18, 2025

View reviewed changes

hanspagel force-pushed the feat/external-docs branch from 3054b45 to 999ebca Compare July 18, 2025 08:01

hanspagel enabled auto-merge (squash) July 18, 2025 08:01

hanspagel force-pushed the feat/external-docs branch from 999ebca to ba45ba6 Compare July 18, 2025 08:10

hanspagel and others added 22 commits July 18, 2025 10:10

feat(api-reference): show externalDocs

2e0dca9

docs(changeset): feat: render External Documentation Objects

747e97d

docs(changeset): feat: add externalDocs

7211d28

feat(themes): adds a element base style

c30fd44

docs(changeset): feat: adds a element base style

5e59afc

style(api-reference): favors active collection over legacy parsed spec

dce0981

chore: fix tests

8dabaf2

Update packages/api-reference/src/features/ExternalDocs/ExternalDocs.vue

5489209

Co-authored-by: Amrit Kahlon <amrit@scalar.com>

fix: TS error

46b41bb

feat(api-reference): adds info object elements in introduction

3f08f3c

feat(types): updates external docs type to keep 3.1 only

659b9d4

feat(api-reference): adds markdown support for description in externa…

5d2db40

…l dos component

feat(api-reference): favors tailwind usage in tag component

c4f0224

style(api-reference): updates info object to rely on document instead…

f858e70

… of adding props

style(api-reference): info objects

7471062

feat(api-reference): adds link list section component

77d022c

feat(api-reference): moves external docs to request example

0927ef2

refactor: code style

59654f8

chore: clean up

99dcc21

chore: wording

d4276f2

refactor: show link list only if it has content

70d9ec8

fix: test

a747b1c

hanspagel force-pushed the feat/external-docs branch from ba45ba6 to a747b1c Compare July 18, 2025 08:10

hanspagel merged commit fb62e1b into main Jul 18, 2025
38 checks passed

hanspagel deleted the feat/external-docs branch July 18, 2025 08:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(api-reference): show External Documentation Object #5623

feat(api-reference): show External Documentation Object #5623

hanspagel commented May 12, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented May 12, 2025 •

edited

Loading

Uh oh!

antlio commented May 29, 2025 •

edited

Loading

Uh oh!

cameronrohani commented Jun 10, 2025

Uh oh!

relativeci bot commented Jun 11, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 11, 2025 •

edited

Loading

Uh oh!

marclave left a comment

Uh oh!

antlio commented Jun 11, 2025 •

edited

Loading

Uh oh!

amritk commented Jun 11, 2025

Uh oh!

amritk commented Jun 11, 2025

Uh oh!

Uh oh!

amritk commented Jun 20, 2025

Uh oh!

antlio left a comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

feat(api-reference): show External Documentation Object #5623

feat(api-reference): show External Documentation Object #5623

Conversation

hanspagel commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

antlio commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cameronrohani commented Jun 10, 2025

Uh oh!

relativeci bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

#11488 Bundle Size — 2.61MiB (+0.62%).

Uh oh!

github-actions bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marclave left a comment

Choose a reason for hiding this comment

Uh oh!

antlio commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

amritk commented Jun 11, 2025

Uh oh!

amritk commented Jun 11, 2025

Uh oh!

Uh oh!

amritk commented Jun 20, 2025

Uh oh!

antlio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

hanspagel commented May 12, 2025 •

edited

Loading

changeset-bot bot commented May 12, 2025 •

edited

Loading

antlio commented May 29, 2025 •

edited

Loading

relativeci bot commented Jun 11, 2025 •

edited

Loading

github-actions bot commented Jun 11, 2025 •

edited

Loading

antlio commented Jun 11, 2025 •

edited

Loading