Skip to content

chore(docs): remove obsolete TODO and placeholder comments - #4633

Open
thetaPC wants to merge 1 commit into
mainfrom
commented-docs
Open

chore(docs): remove obsolete TODO and placeholder comments#4633
thetaPC wants to merge 1 commit into
mainfrom
commented-docs

Conversation

@thetaPC

@thetaPC thetaPC commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

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 in item.md describing 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.md described enabling the detail arrow on md items with --item-detail-push-show. That variable no longer exists in the framework. The detail property does this now, and the prose directly above the comment already documents it.
  • datetime-button.md had empty Customization, Buttons, and Theming stubs. The component exposes one CSS shadow part and no custom properties, both already listed by the auto-generated tables on the page.
  • cli.md asked whether to add an image of the --help output. That output is generated as real text under docs/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.md and what-are-progressive-web-apps.md had TOC goes here placeholders from the pre-Docusaurus generator. Docusaurus renders the table of contents in the sidebar, and neither page sets hide_table_of_contents.

Does this introduce a breaking change?

  • Yes
  • No

Other information

N/A

@vercel

vercel Bot commented Aug 12, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ionic-docs Ready Ready Preview Aug 12, 2026 9:36pm

Request Review

@thetaPC
thetaPC marked this pull request as ready for review August 12, 2026 21:57
@thetaPC
thetaPC requested a review from a team as a code owner August 12, 2026 21:57
@thetaPC
thetaPC requested a review from ShaneK August 12, 2026 21:57
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.

1 participant