-
Notifications
You must be signed in to change notification settings - Fork 246
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
Create Docs for Liger-Kernel #485
Conversation
update docs on low-level apis, taking ref from gpu-mode repo.
Could you please review the changes? cc: @ByronHsu |
Could you please review the changes? cc: @ByronHsu |
Could you please review the changes? cc: @ByronHsu |
Could you please review the changes? cc: @ByronHsu |
Could you please provide me with an initial review? I'd really love to take this PR forward and work to address any required changes cc: @lancerts |
Hi @ParagEkbote! Sorry for the very late reply since we were focusing on something else. Thank you for the great work and i will try to merge it in 2 days. Can you join our slack channel https://join.slack.com/t/ligerkernel/shared_invite/zt-2yavnspqs-0AYy5jduuxd1GKMGlKgFTw? cc @hebiao064 |
The docs looks good to me, please add Error would be like:
|
Discussed with @ByronHsu, let's merge this nice PR first and we will fix the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Summary
Fixes #64
Instead of using Sphinx which I found to be cumbersome to set-up and iterate upon, I have created the docs using Material for Markdown, which uses markdown files for pages and does not change the original markdown files to a greater extent.
To preview in your local system: run make serve in the terminal.
To build pages: run make build in the terminal.
Index page:
Examples page:
Please let me know if any styling or further corrections are needed and I will make the necessary changes.
cc: @ByronHsu