Skip to content

Remove link to nonexistent section in the top-level README.md file - #1052

Merged
mhucka merged 5 commits into
tensorflow:masterfrom
mhucka:fix-readme-toc
May 3, 2026
Merged

Remove link to nonexistent section in the top-level README.md file#1052
mhucka merged 5 commits into
tensorflow:masterfrom
mhucka:fix-readme-toc

Conversation

@mhucka

@mhucka mhucka commented Apr 17, 2026

Copy link
Copy Markdown
Member

The TOC at the top of the file referred to a Documentation section, but there's actually no such currently in the README file. In addition, there was a Motivation section that was not in the TOC. This PR does a little bit of cleanup by:

  • Removing the TOC entry for Documentation
  • Merging the Motivation section into the Features section and removing a little bit of redundancy in the text

The TOC at the top of the file referred to a _Documentation_ section,
but there's actually no such currently in the README file.
@mhucka
mhucka marked this pull request as ready for review April 17, 2026 19:40
@mhucka
mhucka requested a review from MichaelBroughton April 17, 2026 19:40
@mhucka mhucka changed the title Remove link to nonexistent section Remove link to nonexistent section in the top-level README.md file Apr 17, 2026

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the README.md by removing the 'Documentation' link from the table of contents. The reviewer suggests also adding a link to the 'Motivation' section to improve the completeness of the navigation menu.

Comment thread README.md
@mhucka

mhucka commented Apr 17, 2026

Copy link
Copy Markdown
Member Author

/gemini review

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the README.md by removing the documentation link from the header and merging the 'Motivation' section into the main introduction. A review comment suggests consolidating the merged text to eliminate redundant links and repetitive descriptions of the framework's features.

Comment thread README.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@mhucka
mhucka enabled auto-merge May 3, 2026 05:51
@mhucka
mhucka added this pull request to the merge queue May 3, 2026
Merged via the queue into tensorflow:master with commit 2327009 May 3, 2026
5 checks passed
@mhucka
mhucka deleted the fix-readme-toc branch May 3, 2026 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants