Skip to content

Initialize documentation site #388

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

Merged
merged 1 commit into from
May 1, 2025
Merged

Conversation

rudeigerc
Copy link
Contributor

@rudeigerc rudeigerc commented Apr 30, 2025

What this PR does / why we need it

This pull request provides a documentation site via Hugo with docsy.

Which issue(s) this PR fixes

Closes #355

Special notes for your reviewer

I also moved examples and proposals to the root directory.

I noticed that InftyAI has hosted the website on Vercel, so I also host a preview on Vercel for review. Please feel free to give comments and feedback :)

llmaz-git-docs-site-yuchen-chengs-projects.vercel.app

Does this PR introduce a user-facing change?

NONE

/kind documentation
/cc @kerthcet

@InftyAI-Agent InftyAI-Agent added needs-triage Indicates an issue or PR lacks a label and requires one. needs-priority Indicates a PR lacks a label and requires one. do-not-merge/needs-kind Indicates a PR lacks a label and requires one. labels Apr 30, 2025
@InftyAI-Agent InftyAI-Agent requested a review from kerthcet April 30, 2025 09:54
@kerthcet
Copy link
Member

I'll take a look ASAP, thanks @rudeigerc this is great! ❤️

@kerthcet
Copy link
Member

Seems the site is inaccessible.

@rudeigerc
Copy link
Contributor Author

@kerthcet Maybe blocked by the authorization mechanism of vercel 😂 Please use llmaz-git-docs-site-yuchen-chengs-projects.vercel.app instead.

@cr7258
Copy link
Contributor

cr7258 commented Apr 30, 2025

@rudeigerc The new website is awesome! I just have a minor comment: I see there are two search bars; maybe one is enough. I think we can remove the right one. WDYT?

CleanShot 2025-04-30 at 23 54 20@2x

@kerthcet
Copy link
Member

kerthcet commented May 1, 2025

I think we can keep the search in the navigate bar, remove the one on the left.

Are you ready to merge now? I'm ok to merge this and polish it step by step. @rudeigerc We'll put this under the url of llmaz.inftyai.com via github page I think, not the vercel, because for org project, we need to be a member first IIRC.

@kerthcet
Copy link
Member

kerthcet commented May 1, 2025

And I think we need documentation about how to build the website.

Signed-off-by: rudeigerc <rudeigerc@gmail.com>
@rudeigerc
Copy link
Contributor Author

@cr7258 @kerthcet Thanks for the feedback! It sounds good to me. I removed the left one in the sidebar.

We could add the GitHub workflows and documentation about how to build the website in a separate pull request :)

@rudeigerc rudeigerc changed the title [WIP] Initialize documentation site Initialize documentation site May 1, 2025
@kerthcet
Copy link
Member

kerthcet commented May 1, 2025

/lgtm
/approve
/kind feature

Thanks @rudeigerc it's a great start! We can polish the website with follow ups.

@InftyAI-Agent InftyAI-Agent added lgtm Looks good to me, indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. feature Categorizes issue or PR as related to a new feature. and removed do-not-merge/needs-kind Indicates a PR lacks a label and requires one. labels May 1, 2025
@InftyAI-Agent InftyAI-Agent merged commit 2bb1642 into InftyAI:main May 1, 2025
27 of 29 checks passed
@cr7258 cr7258 mentioned this pull request May 1, 2025
@rudeigerc rudeigerc deleted the docs/site branch May 1, 2025 13:32
@kerthcet
Copy link
Member

kerthcet commented May 1, 2025

https://llmaz.inftyai.com/ is available now, I added a deploy workflow to automatically build the website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. feature Categorizes issue or PR as related to a new feature. lgtm Looks good to me, indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a label and requires one. needs-triage Indicates an issue or PR lacks a label and requires one.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add doc website
4 participants