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 website #18

Open
wenq1 opened this issue Apr 5, 2023 · 3 comments
Open

docs website #18

wenq1 opened this issue Apr 5, 2023 · 3 comments

Comments

@wenq1
Copy link

wenq1 commented Apr 5, 2023

I experimented an initial docs website using vitepress. See if you like it.

$ git clone https://github.com/wenq1/vitepress-mulle
$ cd vitepress-mule
$ npm i
$ npm run docs:dev

image

@mulle-nat
Copy link
Member

It looked at it and it looks nice, but to me this seems just a different take on jekyll really. So if we were to migrate the dox from jekyll to vitepress, what's really the gain ?

@wenq1
Copy link
Author

wenq1 commented Apr 6, 2023

theres no gain in terms of technology, which I don’t think matters. Efforts could be made to make documentation easier and get some missing pieces in in place.

what matters is all the docs better be in one place. guides, examples, api references, technical details, blogs are all over the place at this moment.

@mulle-nat
Copy link
Member

I think or hope that in the short run, the documentation problem will be fixed by AI. You can already ask it some questions about mulle-objc, and the results aren't all that bad. With a more custom tailored AI, the results could be even better.

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

No branches or pull requests

2 participants