Skip to content

feat: fill $PROJECT references with the reader's project ID - #131

Open
AriaEdo wants to merge 1 commit into
mainfrom
docs/project-var-alias
Open

AriaEdo wants to merge 1 commit into
mainfrom
docs/project-var-alias

Conversation

@AriaEdo

@AriaEdo AriaEdo commented Nov 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • docs-vars.js: $PROJECT is now an alias of your-project-id, so --project $PROJECT in code blocks shows the reader's project ID.
  • $PROJECT on the left of an assignment (PowerShell $PROJECT = "your-project-id") is left as written. Shiki splits $PROJECT and = ... into separate spans, so the check reads up to 32 chars of the following text nodes.
  • README.md: alias list updated, and the "variable references stay" rule rewritten to match.

Pages affected include domain-dns/point-to-alb.mdx, alb/configuration/waf.mdx, alb/httpproxy/url-rewrite.mdx, alb/httpproxy/https-redirect.mdx.

Test plan

  • Regex checked in node: --project $PROJECT matches; $PROJECT = "x", $PROJECT = 1, ${PROJECT}, bare PROJECT, MY_PROJECT_ID do not.
  • In the browser, on a PowerShell tab (e.g. WAF page): set a project ID, confirm $PROJECT = "..." stays and --project $PROJECT shows the value.
  • Same check on a bash tab: PROJECT="..." and --project $PROJECT both show the value.
  • Copy button copies the filled-in values.

Known side effect: $PROJECT==… (no space) is also not replaced; no doc uses it today.

Treat $PROJECT as an alias of your-project-id so commands like
--project $PROJECT show the reader's value. Assignments
($PROJECT = "your-project-id") are left as written, checking text
past Shiki's span split. Update the README rules to match.
@mintlify

mintlify Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Datum 🟢 Ready View Preview Nov 5, 2026, 9:29 AM

This branch was successfully deployed

1 active deployment
staging — 6b7db793 Deployed Nov 5, 2026 by mintlify[bot]
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