Skip to content

[documentation] update doc for v0.5 - #1285

Merged
zyaoj merged 8 commits into
mainfrom
zy/v05-doc-sprint00-01
Sep 8, 2025
Merged

[documentation] update doc for v0.5#1285
zyaoj merged 8 commits into
mainfrom
zy/v05-doc-sprint00-01

Conversation

@zyaoj

@zyaoj zyaoj commented Sep 8, 2025

Copy link
Copy Markdown
Contributor

What does this PR do? Please describe:

  • Add basic doc on assets
  • Bring back (updated) installation instructions
  • Bring back (updated) add model tutorial + pudb tutorial
  • Introduce doctest
  • Update some API references

N/A

Check list:

  • Was the content of this PR discussed and approved via a GitHub issue? (no need for typos or documentation improvements)
  • Did you read the contributor guideline?
  • Did you make sure that your PR does only one thing instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests?
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (no need for typos, documentation, or minor internal changes)

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 8, 2025
@zyaoj
zyaoj marked this pull request as ready for review September 8, 2025 09:48
@zyaoj zyaoj self-assigned this Sep 8, 2025
@zyaoj
zyaoj requested a review from cbalioglu September 8, 2025 09:49

@cbalioglu cbalioglu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for last minute improvements to the documentation! Left a few comments, mostly nit ones.

Comment thread doc/source/basics/building_recipes.rst Outdated
Comment thread doc/source/basics/runtime_extension.rst Outdated
Comment thread doc/source/basics/runtime_extension.rst Outdated
Comment thread doc/source/basics/runtime_extension.rst Outdated
Comment thread doc/source/reference/api/models/index.rst Outdated
Comment thread doc/source/reference/api/models/index.rst
Comment thread doc/source/tutorials/add_model.rst
Comment thread doc/source/tutorials/add_model.rst
Comment thread doc/source/tutorials/add_model.rst
Comment thread doc/source/tutorials/add_model.rst Outdated

@cbalioglu cbalioglu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I think we are almost there. Left a few final comments.

Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/basics/assets.rst Outdated
Comment thread doc/source/reference/api/models/qwen.rst Outdated

@cbalioglu cbalioglu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@zyaoj
zyaoj merged commit 8a1d4bf into main Sep 8, 2025
3 checks passed
@zyaoj
zyaoj deleted the zy/v05-doc-sprint00-01 branch September 8, 2025 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants