Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
StefanoFioravanzo
force-pushed
the
feature/new-docs
branch
2 times, most recently
from
abe14ea to
28c831d
Compare
Scaffolds the kale.kubeflow.org documentation site using Sphinx + Furo + MyST, mirroring the Kubeflow SDK docs stack. Covers getting-started, core concepts, user guide, architecture, API reference (autodoc), the GSoC 2026 roadmap, and contributing. Closes kubeflow#747. - Sphinx config, Read the Docs config, and GitHub Actions build check - Add `docs` extra to pyproject.toml and lock with uv - New `make docs` / `make docs-serve` targets - Minimal module-level docstrings on core modules for cleaner autodoc Assisted-by: Claude (claude-opus-4-6) Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com>
StefanoFioravanzo
force-pushed
the
feature/new-docs
branch
from
9899e64 to
1715677
Compare
There was a problem hiding this comment.
@StefanoFioravanzo I read the docs and I really like it, I have suggestion for the CI, and I think it would also be nice to mention somewhere the JupyterLab settings that Kale has - enable by default and auto-save, otherwise LGTM!
jesuino
left a comment
jesuino
left a comment
There was a problem hiding this comment.
Great content, thanks for this! Just a few comments
hmtosi
left a comment
hmtosi
left a comment
There was a problem hiding this comment.
Thank you @StefanoFioravanzo for this work - overall I think it is very well done and very helpful.
I left a few comments about the content, where the information could be more technical or more specific.
Otherwise, most of my comments are just about formatting errors - about 70% of the links do not have the [ ] filled in (so the url is there but it will not appear in the rendered .md file). I commented on the files that had this issue.
This work will be a great addition to the v2.0 release!
| @@ -0,0 +1,155 @@ | |||
| --- | |||
There was a problem hiding this comment.
the formatting notation in this file does not render correctly, at least on my side
There was a problem hiding this comment.
hmmm I don't see wrong formatting on my end, could you share a screenshot?
There was a problem hiding this comment.
For me, things like ::::{grid} are not being formatted when I look at the Mardown preview in google chrome
There was a problem hiding this comment.
ahhh right.. indeed this is not standard markdown, but something that sphynx interprets. I guess most folks will read the docs from the website, no? I feel like it's not that big of a deal if this md file is difficult to read, if we can have a nicer docs homepage. Happy to reconsider if you feel differently!
There was a problem hiding this comment.
You are right, I think it aligns with our discussion of having these md docs be more agent-focused, and then we have a readme that is more human-readable.
Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com>
Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com> Co-Authored-by: Hannah Tosi <htosi@redhat.com>
|
@hmtosi added a commit with the screenshots, thanks for taking the time to capture them!! :) |
jesuino
left a comment
jesuino
left a comment
There was a problem hiding this comment.
Just two small comments to remove the mention to KFP Host of Left from the image.
I ran the make docs-serve locally and I was able to see that all images are in place and I see no problems with formatting.
Thanks again!
@jesuino fixed, thanks! |
jesuino
left a comment
jesuino
left a comment
There was a problem hiding this comment.
Thank you for the updates, @StefanoFioravanzo - I found what I think to be the last change - Please apologize for not spotting this before
Signed-off-by: Stefano Fioravanzo <stefano.fioravanzo@gmail.com>
StefanoFioravanzo
force-pushed
the
feature/new-docs
branch
from
d9df657 to
f2f286d
Compare
hmtosi
left a comment
hmtosi
left a comment
There was a problem hiding this comment.
/lgtm
Thank you for making the changes @StefanoFioravanzo, it is all set from my perspective
4 participants
Introducing new docs for the Kale 2.0 launch
Addresses part of #747
@ederign he's a first iteration, I got sidetracked today and didn't finish.. there are some issues with some of the Claude output :) I will revisit tomorrow.
In the meantime