chore: Documentation updates and cleaning up root folder #117
chore: Documentation updates and cleaning up root folder #117bartoszmajsak merged 2 commits intomainfrom
Conversation
…ate information, as well as moving files out of our root directory to help tidy up a little bit
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes. 💤 Files selected but had no reviewable changes (6)
You can disable this status message by setting the WalkthroughDocumentation was overhauled: the root README was rewritten to shift focus to OpenShift/KServe and simplified sections; quick-start and architecture content were removed; links and prerequisites were updated. App-level docs were adjusted for a script path change and a WIP frontend note. A new WIP local deployment doc was added. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
jland-redhat
changed the title
docs/LOCAL_DEPLOYMENT.md
Outdated
There was a problem hiding this comment.
Isn't the README file in docs/ sufficient for explaining local deployment? Maybe just reference it? Or you have a greater idea for a separate set of instructions in this file? #_#
There was a problem hiding this comment.
I think our docs are going to grow overtime and it tends to get messy when you don't have a cordoned off place for them.
See the lllama stack repo for an example of what I mean:
https://github.com/llamastack/llama-stack/tree/main/docs
We can also eventually create a workflow that deploys a documents page for us, similar to this created from the docs folder above:
https://llama-stack.readthedocs.io/en/latest/
So in short the "greater idea" thing
docs/LOCAL_DEPLOYMENT.md
Outdated
There was a problem hiding this comment.
Maybe we can just remove it until we have something concrete to share? Brings back memories of "website under construction" :)
There was a problem hiding this comment.
Yeah my thought here was more of trying to start the outline of what our docs would actually look like. But we can just remove this for now.
|
LGTM |
…-io#117) * Updated the main README to reduce what was shown, and remove out of date information, as well as moving files out of our root directory to help tidy up a little bit * Addressing comments --------- Co-authored-by: Jamie Land <hokie10@gmail.com>
5 participants
Moving some files around to help clean up our root directory. And updating the README to remove out of date information, and also help the user more quickly get to the the deployment guide.
Going to update deployment guides in followup PRs
Summary by CodeRabbit