Skip to content

Conversation

dominikg
Copy link
Member

This moves the docs markdown files into a structure parsable by svelte.dev generator and adds symlinks in the old places so that existing links keep working.

@dominikg dominikg force-pushed the docs/omni-site-reformat branch from 7018c95 to fddeb85 Compare August 18, 2025 15:30
Copy link
Member

@eltigerchino eltigerchino Aug 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth thinking about de-duplicating the config option info between this file (and potentially others) and the JSDocs? (generating the docs from the JSDoc types like we do in Svelte and SvelteKit)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how does that work and can it be added to a pre-commit hook + ci check?

Copy link
Member

@eltigerchino eltigerchino Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you'll have to ask Elliot who made new changes to the svelte.dev bot https://discordapp.com/channels/457912077277855764/1385015784564330589/1409640631160012810

For how it works, there's an example in https://github.com/sveltejs/kit/blob/main/documentation/docs/98-reference/50-configuration.md there seems to be some kind of notation such as > TYPES: Configuration#Config but we probably need to find out from @Rich-Harris and document it somewhere

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.

2 participants