chore(docs): remove obsolete TODO and placeholder comments - #4633
Open
thetaPC wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue URL: N/A
What is the current behavior?
Five commented-out notes are scattered through the docs, left as reminders to come back and write something later. Two are section stubs in
datetime-button.md, one is a block initem.mddescribing a CSS variable, one asks whether the CLI help section needs a screenshot, and two are placeholders where a table of contents used to be generated inline.All five have been overtaken by changes elsewhere, so none of them describe work that still needs doing.
What is the new behavior?
Removes the five notes from the current docs and their v7 copies. These are MDX comments, so nothing changes in the rendered pages.
Each was checked against its current replacement before removal:
item.mddescribed enabling the detail arrow onmditems with--item-detail-push-show. That variable no longer exists in the framework. Thedetailproperty does this now, and the prose directly above the comment already documents it.datetime-button.mdhad emptyCustomization,Buttons, andThemingstubs. The component exposes one CSS shadow part and no custom properties, both already listed by the auto-generated tables on the page.cli.mdasked whether to add an image of the--helpoutput. That output is generated as real text underdocs/cli/commands/, which stays current as the CLI changes. A static image would go stale, would not be translatable or searchable, and would contradict the note above it explaining that help output differs per project type.versioning.mdandwhat-are-progressive-web-apps.mdhadTOC goes hereplaceholders from the pre-Docusaurus generator. Docusaurus renders the table of contents in the sidebar, and neither page setshide_table_of_contents.Does this introduce a breaking change?
Other information
N/A