Skip to content
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

Documentation Followup #6914

Open
wants to merge 53 commits into
base: master
Choose a base branch
from

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Sep 10, 2024

This addresses several of the points in Issue #6912

The many changes include:

  • Change the "Run in Google Colab" etc. links to real buttons
  • Fix many broken links
  • Fix formatting errors, including improperly rendered unordered lists
  • Add "Addons" Page
  • Remove TF logo
  • Fix admonitions in api docs, guides, and tutorials
  • Make sure all module members that should be present in api docs are present

Here is a preview

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@smokestacklightnin smokestacklightnin linked an issue Sep 18, 2024 that may be closed by this pull request
5 tasks
@smokestacklightnin smokestacklightnin marked this pull request as ready for review September 18, 2024 02:28
Copy link
Contributor

@peytondmurray peytondmurray left a comment

Choose a reason for hiding this comment

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

I haven't checked every link, but perhaps that's best for Lychee or similar tools. Otherwise this looks good.

@@ -1,3 +1,6 @@
# Orchestration

::: tfx.v1.orchestration
options:
show_if_no_docstring: true
<!-- show_submodules: true -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Commented out - please remove.

@gbaned gbaned self-assigned this Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Assigned Reviewer
Development

Successfully merging this pull request may close these issues.

Documentation Follow-up Work
5 participants