Skip to content

Docs: remove hardcoded Foundry instance targets#22

Merged
anand-testcompare merged 1 commit intomainfrom
docs-sanitize-foundry-targets
Feb 15, 2026
Merged

Docs: remove hardcoded Foundry instance targets#22
anand-testcompare merged 1 commit intomainfrom
docs-sanitize-foundry-targets

Conversation

@anand-testcompare
Copy link
Collaborator

@anand-testcompare anand-testcompare commented Feb 15, 2026

Replace enrollment-specific Foundry identifiers (stack URL, compute module RID, project path) with placeholders.

Why:

  • avoids leaking internal instance details (e.g. 23dimethyl...)
  • makes the Foundry runbook/TODO reusable across enrollments

Files:

  • docs/foundry-openapi-runbook.md
  • TODO.md

Summary by CodeRabbit

  • Documentation
    • Restructured configuration setup sections with clearer labeling for user guidance
    • Added instructions for users to input their Foundry enrollment values
    • Updated configuration examples with placeholder values for improved setup clarity

Replace enrollment-specific URLs/RIDs/paths in docs with placeholders so the repo can be reused across stacks without leaking internal instance details.
@railway-app railway-app bot temporarily deployed to dspy-reference-example / dspy-reference-examples-pr-22 February 15, 2026 17:36 Destroyed
@railway-app
Copy link

railway-app bot commented Feb 15, 2026

🚅 Deployed to the dspy-reference-examples-pr-22 environment in dspy-reference-example

Service Status Web Updated (UTC)
dspy-reference-examples ✅ Success (View Logs) Web Feb 15, 2026 at 5:37 pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 15, 2026

Walkthrough

Two documentation files are updated to replace static example values with placeholder guidance. Section headers are renamed from "Locked Identifiers/Targets" to "Targets (Fill In)" to direct users to provide their own Foundry enrollment configuration values.

Changes

Cohort / File(s) Summary
Documentation guidance updates
TODO.md, docs/foundry-openapi-runbook.md
Section headers renamed to "Targets (Fill In)" and static example values replaced with guidance prompts instructing users to substitute their own Foundry enrollment-specific values (FOUNDRY_URL, COMPUTE_MODULE_RID, FOUNDRY_REPOSITORY, FOUNDRY_PROJECT_PATH).

Possibly related PRs

Poem

🐰 The docs now dance with open space,
No frozen values set in place!
Just placeholders waiting true,
For users' own Foundry brew.
Fill us in, and all is right! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: removing hardcoded Foundry instance targets from documentation and replacing them with placeholders.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-sanitize-foundry-targets

No actionable comments were generated in the recent review. 🎉


Comment @coderabbitai help to get the list of available commands and usage tips.

@anand-testcompare anand-testcompare merged commit c552956 into main Feb 15, 2026
9 checks passed
@anand-testcompare anand-testcompare deleted the docs-sanitize-foundry-targets branch February 15, 2026 19:35
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