Skip to content

organizes new articles into the existing pages for descriptions and groups #82350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

heckj
Copy link
Member

@heckj heckj commented Jun 18, 2025

Updates the curation (organization) for the newer articles in diagnostics.

3 articles were floating below the organized pages - this merges them into those groups.

  • 1 new diagnostic description
  • 2 new group descriptions

Reviewed manually with:

cd userdocs
xcrun docc preview diagnostics --allow-arbitrary-catalog-directories

@heckj heckj requested a review from bnbarham June 18, 2025 19:46
@heckj heckj self-assigned this Jun 18, 2025
@heckj
Copy link
Member Author

heckj commented Jun 18, 2025

@swift-ci please test

@@ -31,4 +33,5 @@ Or upgrade all warnings except deprecated declaration to errors:
- <doc:strict-language-features>
- <doc:strict-memory-safety>
- <doc:unknown-warning-group>

- <doc:availability-unrecognized-name>
- <doc:missing-module-on-known-paths>
Copy link
Contributor

@bnbarham bnbarham Jun 18, 2025

Choose a reason for hiding this comment

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

Ah... I really need to add that check I said I'd add in 😬 Thanks for adding these. I know you didn't add it, but would you like to summarize the initial paragraph in missing-module-on-known-paths? It's a bit long for the one-liner IMO.

EDIT: Also, mind making the additions alphabetical?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't have a sense for the size this will grow to, but if the list gets notably longer, it would make a lot of sense to start looking for ways to group these rather than utilizing alphabetical organization. And even that's tricky, as not all the markdown file names align to the titles in those articles. Changing the markdown file name will change the the URL that the page is pinned out, so if you're referencing these externally - I'd recommend being quite strict about those changes, and maybe building up a convention of always naming the markdown file after the name of the Group or Diagnostic.

I'd be happy to retrofit the markdown file name in a separate PR if you'd like to go that route.

@heckj
Copy link
Member Author

heckj commented Jun 20, 2025

@swift-ci please test

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