Skip to content

feat: use starlight-typedoc - #3986 - #4042

Open
FabianLars wants to merge 9 commits into
v2from
typedoc-starlight-md-rebase
Open

FabianLars wants to merge 9 commits into
v2from
typedoc-starlight-md-rebase

Conversation

@FabianLars

@FabianLars FabianLars commented Aug 6, 2026 •

Copy link
Copy Markdown
Member

Rebase of #3986

Closes #4052

@FabianLars
FabianLars requested a review from a team as a code owner August 6, 2026 19:48
@github-project-automation github-project-automation Bot moved this to 🪵 Backlog in Documentation Aug 6, 2026
@netlify

netlify Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for tauri-v2 ready!

Name Link
🔨 Latest commit 97ecbb2
🔍 Latest deploy log https://app.netlify.com/projects/tauri-v2/deploys/6ad28b42a023b764a47b3e54
😎 Deploy Preview https://deploy-preview-4042--tauri-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 98 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for tauri-releases canceled.

Name Link
🔨 Latest commit 81add0a
🔍 Latest deploy log https://app.netlify.com/projects/tauri-releases/deploys/6a74e509eaa18a0008509ce7

@socket-security

socket-security Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addedtypedoc-plugin-frontmatter@​1.3.21001007887100
Addedstarlight-typedoc@​0.23.11001008089100

View full report

@Legend-Master

Copy link
Copy Markdown
Contributor

I wonder if it's possible to show the parameter types inline, instead of in a table below

image

compared to

image

@vasfvitor

Copy link
Copy Markdown
Contributor

yeah afaik there's an option, btw should I bring it closer to v1 like the example section being up top?

@Legend-Master

Copy link
Copy Markdown
Contributor

btw should I bring it closer to v1 like the example section being up top?

yeah if the parameter types are inlined with just the type references below, then they should be below everything else

@vasfvitor

vasfvitor commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

enum as table
image

expand objects
image
image
at reference/javascript/api/namespacedpi


https://deploy-preview-4042--tauri-v2.netlify.app/reference/javascript/api/namespacedpi/
without expand
image
with expand objects
image

@vasfvitor

vasfvitor commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

I'm going to rebase merge and do a bit of work on the css

@Legend-Master

Copy link
Copy Markdown
Contributor

Also it seems like currently the functions were shown at the end, would it make sense to show them first? Since most of the useful things we provide are the functions as classes, the types, enums are all helpers

@vasfvitor

Copy link
Copy Markdown
Contributor

you mean this?
image

specifically for this page https://deploy-preview-4042--tauri-v2.netlify.app/reference/javascript/api/namespaceapp/#type-aliases I'd argue that moving functions up would bury the other down below on the TOC. Unless the opposite is also true in other pages (many enum and helpers that hides the function on TOC), in that case either way this would be an issue so it ends as a matter of preference

@vasfvitor

vasfvitor commented Aug 18, 2026 •

Copy link
Copy Markdown
Contributor

or I could reduce the toc depth to 2 levels

@Legend-Master

Copy link
Copy Markdown
Contributor

Yeah that's what I meant. I wouldn't mind this too much either ways that this should only be for looking up certain APIs anyways

@vasfvitor

Copy link
Copy Markdown
Contributor

@Legend-Master what do you think about the toc depth? It is also possible to remove the 'Functions', 'Enumerations' headings but I tried and it not so clear at glance

before/after toc depth (not same image but close)
image

image

before/after toc depth
image
image

@vasfvitor
vasfvitor force-pushed the typedoc-starlight-md-rebase branch 2 times, most recently from 86109f7 to 9bc0f00 Compare October 16, 2026 20:18
@vasfvitor
vasfvitor force-pushed the typedoc-starlight-md-rebase branch from 9bc0f00 to 97ecbb2 Compare October 16, 2026 20:38

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🪵 Backlog

Development

Successfully merging this pull request may close these issues.

3 participants