Replies: 7 comments
-
On one side we could improve the documentation with using mdbook, but i like the idea of having a docs.rs page more becauseit makes the maintainability easier because of in-code documentation and also will allow us in the future to split of the backend from the frontend and publishing the backend in an own lib crate. |
Beta Was this translation helpful? Give feedback.
-
I was thinking as using mdbook as a website for configuration without need to now all internal stuff, just information about usage and configuration |
Beta Was this translation helpful? Give feedback.
-
Sounds good for me. |
Beta Was this translation helpful? Give feedback.
-
I would go with a dedicated repository then. What do you need for that? New repo with read/write rights? |
Beta Was this translation helpful? Give feedback.
-
Yes, a repo called |
Beta Was this translation helpful? Give feedback.
-
I set you as a maintainer of the new repository. It should work for now. Edit: Typo |
Beta Was this translation helpful? Give feedback.
-
Since the website now exists, I'll close this. Any further communication about the website should take place in https://github.com/topgrade-rs/topgrade-rs.github.io. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
I would suggest to use mdbook and GitHub pages for adding documentation.
So, user will just be able to go to the documentation website instead of the wiki. Maybe a repo in the org for a short URL. I'll glad to work on that if you approve
Beta Was this translation helpful? Give feedback.
All reactions