Remove duplicated CLI Options section #678
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Vercel Previews Deployed
|
lafentres
changed the title
Contributor
Broken Link CheckerNo broken links found! 🎉 |
natalie-todd
approved these changes
Aug 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes a bug in the docs where the "CLI options" section was included twice.
This happened because the original title-cased "CLI Options" header and all other headers were modified to sentence-case in this PR to match the docs style guide. The "CLI Options" header was in a section that should never be directly edited because it is automatically generated by the update_website Makefile target in the tfc-agent repo. Changing the casing of the header in the docs repo directly made the update_website Makefile target not work as expected. Instead of replacing the existing "CLI Options" setting, it appended a new section because the header casing no longer matched what was expected. The means the content under "CLI options" was outdated and the content under "CLI Options" was the most up to date.
This PR cleans that up and makes the existing warning about not editing this section a little easier to see. I have a separate PR open to update the header to sentence-casing directly in the tfc-agent repo.
Screenshots
Before
After
Related Links