Skip to content

Conversation

@fnune
Copy link
Member

@fnune fnune commented Feb 11, 2026

Summary

  • Add blog post announcing registry usage columns and filters
  • Update private registry docs with registry views and usage tracking sections

Test plan

  • Verify blog post renders correctly
  • Verify docs render correctly
  • Replace meta.png placeholder before publish

@claude
Copy link
Contributor

claude bot commented Feb 11, 2026

Documentation Review

I've reviewed PR #17531 which adds registry usage insights documentation and blog post. Overall, the content is well-structured and informative. Here are my findings:

Critical Issues

1. Broken documentation link in blog post (line 72)

The blog post references /docs/idp/get-started/private-registry/, but this path does not exist. The correct path is /docs/idp/concepts/private-registry/.

Navigate to **Platform > Registry** in Pulumi Cloud to explore your organization's packages with the new usage columns and filters. For more details on the private registry features, see the [Private Registry documentation](/docs/idp/concepts/private-registry/).

2. Duplicate image reference in blog post (line 41)

The "Filter dropdown" section uses the same image (usage-columns.png) as the "What You Can See" section above. This appears to be incorrect, as the alt text suggests it should show a filter dropdown, not usage columns.

Please verify if this is the correct image or if a different screenshot showing filters is needed.

3. Placeholder meta.png (SVG file)

The meta.png file is actually an SVG placeholder (contains XML/SVG markup, not a PNG). The PR test plan mentions "Replace meta.png placeholder before publish" - this needs to be completed before merging. The meta image is critical for social media sharing.

Style and Content Issues

4. Blog post: Inconsistent list formatting (lines 33-35)

According to STYLE-GUIDE.md, all ordered list items should begin with 1. for consistency:

1. **Stacks on latest**: the number of stacks running the latest version
1. **Not on latest**: the number of stacks running older versions
1. **Total**: all stacks using any version of the package

5. Documentation: Heading could be more specific (line 39)

The heading "Usage tracking" in the docs is quite generic. Consider making it more specific to improve scanability:

## Package usage tracking

6. Documentation: Improved section organization

The "Component usage tracking" section was removed and integrated into "Usage tracking", but the flow could be clearer. Consider explicitly mentioning that usage tracking applies to both the Registry and Private Components tabs, since this was reorganized.

Minor Issues

7. Blog post: Consider rewording security scenario (line 65)

The phrase "when a CVE drops" is somewhat informal for documentation. Consider:

- **Security response**: when a security vulnerability is disclosed, filter to "Not on latest" and immediately see which stacks need attention

8. Documentation: Menu reference needs verification (line 25)

The image shows "Platform menu showing Registry tab", but please verify this matches the actual UI. The screenshot shows it's named platform-menu.png but it may be duplicated from registry-tab.png.

Positive Aspects

  • Clear, focused content that explains the feature value proposition well
  • Good use of concrete examples (CVE response, deprecation planning)
  • Proper use of sentence case for H2+ headings
  • Descriptive alt text for images
  • Clean markdown formatting overall
  • Well-structured "Why This Matters" section addresses real use cases

Before Merging

  1. Fix the broken documentation link (critical)
  2. Replace the placeholder meta.png with an actual PNG image (mentioned in test plan)
  3. Verify the filter dropdown image is correct or replace it
  4. Update list numbering to use 1. throughout

Great work on documenting this feature! Once the critical issues are addressed, this will be ready to publish. Mention @claude if you'd like me to review again after making changes.

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@kramhuber
Copy link
Contributor

@claude can you re-run your analysis?

@claude
Copy link
Contributor

claude bot commented Feb 11, 2026

Claude encountered an error —— View job


Re-running Documentation Review

Tasks

  • Read all changed files
  • Compare against previous review findings
  • Perform fresh analysis
  • Provide comprehensive feedback

Co-authored-by: Mark <mark@pulumi.com>
@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

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.

4 participants