aibrix icon indicating copy to clipboard operation
aibrix copied to clipboard

Document for mocked cpu app within quickstart page

Open Colstuwjx opened this issue 9 months ago • 2 comments

Hi team, I've found that we've filed a document for illustrating how to do the local development, see repo folder, however, there are two issues:

  1. it's not clear for end users to check out the document since the document page didn't have the full guide, instead, we need to check the repo folder for more details, which is really painful;
  2. in order to improve the user experience for the end users, could we update the quickstart page to add the cpu type vllm model example so that it's more easier to try out aibrix features.

Thanks.

Colstuwjx avatar Mar 03 '25 04:03 Colstuwjx

@Colstuwjx thanks for the recommendation. We missed this issue. Do you want to cut a PR? If you do not have bandwidth, we can help make it

Jeffwan avatar May 23 '25 21:05 Jeffwan

Hi, @Jeffwan . I’ve already used the framework locally and agree that the quickstart page could definitely be improved with a clearer, step-by-step example for the CPU type vLLM model. I’d like to take this up as my first PR to help improve the docs and user experience. I’ll prepare a clear example and update the quickstart page accordingly. Expect a PR soon. If there are any specific requirements or formatting guidelines you want me to follow, please let me know.

jiahuipaung avatar May 28 '25 16:05 jiahuipaung