Skip to content

Vitepress based documentation #1061

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

Closed
wants to merge 3 commits into from
Closed

Conversation

lazarusA
Copy link

let's see.

@avik-pal
Copy link
Member

avik-pal commented Jun 1, 2024

We need a proper support for MultiDocumenter before SciML can adopt vitepress

@avik-pal
Copy link
Member

avik-pal commented Jun 1, 2024

Also buildkite deployment detection fails for reasons unknown, that's why we had added passing in the decision variable to Vitepress. See how Lux does it https://github.com/LuxDL/Lux.jl/blob/60c595ec9490dbdcce70c21ec4d577ef1d4f9165/docs/make.jl#L87-L88

@lazarusA
Copy link
Author

lazarusA commented Jun 1, 2024

We need a proper support for MultiDocumenter before SciML can adopt vitepress

Definitely, (or similar?). I just wanna to see if something could be broken. This is a huge use case. I will take a look at the deploy issue again. Thanks.

@ChrisRackauckas
Copy link
Member

Yes multidocumenter is essential. Notsure how this connects to it.

@avik-pal
Copy link
Member

avik-pal commented Jun 2, 2024

It still isn't detecting the key. This is probably because buildkite disables forks from accessing secrets?

@lazarusA
Copy link
Author

lazarusA commented Jun 2, 2024

apparently it builds without any issues. I will take this as a good sign 😄. The multidocumenter thing is not just a super navigator tab for all repos?

@ChrisRackauckas
Copy link
Member

ChrisRackauckas commented Jun 3, 2024

Yeah it demonstrates it's viable. It just needs multidocumenter and key things. @thazhemadam can do the key things, but we should wait until there's a plan with multidocumenter @pfitzseb

@ChrisRackauckas ChrisRackauckas changed the title test CI Vitepress based documentation Jun 3, 2024
@ChrisRackauckas
Copy link
Member

Closing as it is stale, but we are talking with @asinghvi17 about doing something to SciML hopefully down the line. I want to get SciML to vitepress but we need to think more about the whole multidocumenter setup and less about the single repos.

@pfitzseb
Copy link

MultiDocumenter 0.8 should somewhat support vitepress generated docs, at least visually. You will get two top-bars and potential keybinding conflicts though.

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.

4 participants