Skip to content

Add detailed Claude.md and Cursor/rules #15137

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 1 commit into
base: master
Choose a base branch
from

Conversation

meagancojocar
Copy link
Collaborator

Proposed changes

Unreleased product version (optional)

Related issues (optional)

@pulumi-bot
Copy link
Collaborator

Copy link
Member

@mikhailshilkov mikhailshilkov left a comment

Choose a reason for hiding this comment

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

Two files seem similar but different in many ways. How are we thinking about keeping them in sync vs. entirely independent?


#### **Pulumi CLI Commands**

- Use specific shortcodes for CLI references: `{{< pulumi-new >}}`, `{{< pulumi-apply >}}`, etc.
Copy link
Member

Choose a reason for hiding this comment

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

What is pulumi-apply?

Copy link
Contributor

@thoward thoward Jun 4, 2025

Choose a reason for hiding this comment

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

In this case, it's a short code for Output.apply. See: https://github.com/pulumi/docs/blob/master/layouts/shortcodes/pulumi-apply.html

What the short code does is select the language-specific casing of the apply function (e.g. Apply vs apply) and links to the SDK documentation for whatever language you've chosen, using the chooser framework under the hood.

It's used in these two docs:

  • If you need to access and use multiple outputs together, the `all` function acts like an [`apply`](/docs/concepts/inputs-outputs/apply/) across many resources, allowing you to retrieve and use multiple outputs at the same time. The `all` function waits for all output values to become available and then provides them as _plain values_ to the {{< pulumi-apply >}} function.
  • Ultimately, if you want to view the properties of a resource, you will need to access them at the individual property level. The rest of this guide will demonstrate how to access and interact with a single property using {{< pulumi-apply >}}.

This is a way to avoid the problem I kept running into, for example, in the "Build a Component" docs, where there are subtle variations on the links/names of functions/classes that require entire prose blocks to be within a chooser (and thus duplicated with minor variations in the Markdown). However, you need to write a custom shortcode like that for every scenario and it's not super obvious what the shortcode does. I didn't do that on the components docs, but the original author of the output/apply docs did do that for apply.

---
title: "Page Title (60 char limit for SEO)"
meta_desc: "SEO description"
author: joe-duffy
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
author: joe-duffy
author: author-id

as below?

- Place images in same directory as blog post
- Reference relatively: `![Alt text](image.png)`
- **Social images:** 1200×628 PNG, opaque background
- Use [Figma template](https://www.figma.com/file/TnD7nxjIxVvXq8w0W7awPG/Build-Your-Own-Meta-Image) for consistency
Copy link
Member

Choose a reason for hiding this comment

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

Oh, that works?! Nice if so.

@jkodroff
Copy link
Member

jkodroff commented May 28, 2025

I don't think I have anything useful to add to this PR, so no need to wait on my review. Nothing here looks harmful, but I don't have a ton of subject matter expertise. Deferring to Mikhail.

Copy link
Contributor

Choose a reason for hiding this comment

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

Much of this file seems duplicative of the style guide, readme, and blogging guides. My understanding is that Claude doesn't need much more directive than "read the style guide" to get this information (e.g. it doesn't have to be duplicated within CLAUDE.md, just mentioned there). The concern I have is drift. If we duplicate (or ~mostly duplicate with some subtle variation) between CLAUDE.md and the style guide, which one is the source of truth? which one do we maintain? seems better to keep all this information contained in the style guide, and just ask Claude to use that. That will work for human readers and for agentic AIs equally.

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.

5 participants