Skip to content

chore(docs): correct ignore lists and drop archived playground versions - #4670

Merged
thetaPC merged 2 commits into
mainfrom
more-archived-stuff
Aug 27, 2026
Merged

chore(docs): correct ignore lists and drop archived playground versions#4670
thetaPC merged 2 commits into
mainfrom
more-archived-stuff

Conversation

@thetaPC

@thetaPC thetaPC commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Issue URL: N/A

What is the current behavior?

.prettierignore covers docs/cli/commands but not the versioned copies, so npm run lint reformats 46 generated files locally after any build.

docs/api is in .prettierignore, but those 94 files are tracked and hand-maintained, not generated. They've drifted from versioned_docs/version-v8/api, which is already prettier-formatted.

The playground generator still offers v6 and v7, which are archived and no longer built. The archiving checklist in CONTRIBUTING doesn't mention updating it.

What is the new behavior?

  • Added versioned_docs/version-v*/cli/commands to .prettierignore
  • Removed docs/api and versioned_docs/version-v*/api from .prettierignore, formatting 93 files
  • Playground generator now offers only 8 and 9
  • Added a step to the CONTRIBUTING archiving checklist for the generator

Does this introduce a breaking change?

  • Yes
  • No

Other information

The api reformat closes a gap rather than opening one. versioned_docs/version-v8/api was already formatted this way. After this, the two trees differ only by v8v9 import paths (87 files) and 7 genuine v9 content changes.

The cli/commands gap never affected CI. Those files are git-ignored and CI never runs generate-markdown, so it only showed up locally.

@vercel

vercel Bot commented Aug 27, 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 27, 2026 5:02pm

Request Review

@thetaPC
thetaPC marked this pull request as ready for review August 27, 2026 15:25
@thetaPC
thetaPC requested a review from a team as a code owner August 27, 2026 15:25
@thetaPC
thetaPC requested a review from OS-jacobbell August 27, 2026 15:25
Comment thread .prettierignore
Comment thread docs/api/input-otp.md
- Use `type="number"` for numeric-only patterns to show the numeric keyboard
- Use `type="text"` for patterns that include letters to show the alphanumeric keyboard
:::
:::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is this indented?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Prettier did that. You can see that it was also applied in the v8 page.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't this wrong though? The beginning of it is not indented.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think it might be how the admonition is being set up. I can look into it on another PR especially if it leads to a lot of file changes. If you prefer it in this PR, let me know.

@thetaPC
thetaPC requested a review from brandyscarney August 27, 2026 20:24
@thetaPC
thetaPC merged commit dc11861 into main Aug 27, 2026
4 checks passed
@thetaPC
thetaPC deleted the more-archived-stuff branch August 27, 2026 22:16
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