Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs on svelte.dev #942

Open
benmccann opened this issue Jul 11, 2024 · 2 comments
Open

Docs on svelte.dev #942

benmccann opened this issue Jul 11, 2024 · 2 comments
Labels
enhancement New feature or request triage Awaiting triage by a project member

Comments

@benmccann
Copy link
Member

Describe the problem

There's a desire to put docs for all the projects into the omnisite. vite-plugin-svelte doesn't really have a docs index page currently. There's the readme, but we might put different content on svelte.dev than what's there. There also isn't a clear order the docs pages should be displayed in the lefthand nav

Describe the proposed solution

Prefix the existing docs with 10-, 20-, etc. to provide an ordering that can be used in the lefthand nav. The docs with the smallest prefix should include some introductory material

Alternatives considered

it may be helpful to update the directory structure of various repos to align with each other, but I think that isn't strictly necessary and we can maintain a mapping of where docs live in each repo

Importance

i cannot use vite-plugin-svelte without it

@benmccann benmccann added enhancement New feature or request triage Awaiting triage by a project member labels Jul 11, 2024
@dominikg
Copy link
Member

happy to add a json file providing metadata, renaming files would cause existing links to break and make it harder for humans to parse what they are looking for.

if you insist on ordering by filename a separate omnidocs with symlinks could be created.

@dominikg
Copy link
Member

we also have one link self referencing it in a log

export const FAQ_LINK_MISSING_EXPORTS_CONDITION =

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Awaiting triage by a project member
Projects
None yet
Development

No branches or pull requests

2 participants