Skip to content

docs: add simplified install guide for admins#1483

Closed
rh-hemartin wants to merge 3 commits into
mainfrom
refactor/installation-guide
Closed

docs: add simplified install guide for admins#1483
rh-hemartin wants to merge 3 commits into
mainfrom
refactor/installation-guide

Conversation

@rh-hemartin
Copy link
Copy Markdown
Contributor

Summary

  • Adds docs/guides/admin/install.md — a simplified installation guide covering both repository mode (recommended) and organization mode
  • Links it from docs/guides/README.md

Test plan

  • Read through the guide for accuracy and completeness
  • Verify all links resolve correctly

🤖 Generated with Claude Code

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 26, 2026

Site preview

Preview: https://6b3e4c44-site.fullsend-ai.workers.dev

Commit: 3ea82ed76b06724ceb493cdc739316213674e78a

@fullsend-ai-review
Copy link
Copy Markdown

fullsend-ai-review Bot commented May 26, 2026

Review

Findings

Medium

  • [correctness] docs/guides/admin/install.md:63 — Hardcoded production mint URL (https://fullsend-mint-gljhbkcloq-uc.a.run.app) in both the repository-mode and organization-mode install commands. The existing full installation guide (installation.md) consistently parameterizes this as $PLATFORM_MINT_URL or $MINT_URL. Hardcoding violates the project's CLAUDE.md policy ("Never commit … internal hostnames") and is fragile — if the mint is redeployed to a different region, this guide silently breaks. The URL also exposes infrastructure details in a public repo.
    Remediation: Replace the hardcoded URL with a variable ($MINT_URL) and add it to the "Export Variables" section with a note to obtain it from the platform operator.

Low

  • [correctness] docs/guides/admin/install.md:88 — The "Next steps" section lists five bullet points ("How to customize default agents", "How to provide skills for agents", etc.) with no links. If the target documentation exists, these should link to it; if it doesn't exist yet, the section should note that these guides are planned, or be omitted until the targets are available.
    Remediation: Add links to existing guides, or add a note like "Coming soon" for planned content, or remove the section until targets exist.

  • [style] docs/guides/README.md:11 — The new entry "How to install fullsend" sits directly above the existing "Installing fullsend" with near-identical naming. The description "A simplified version of the installation guide" doesn't help readers choose between them. Consider clearer differentiation — e.g., "Quick-start installation" vs "Complete installation reference" — or merge the simplified content into the existing guide as a "Quick start" section.
    Remediation: Rename one or both entries to make the distinction obvious (e.g., "Quick-start install" and "Full install reference"), or consolidate.

  • [correctness] docs/guides/admin/install.md:14 — The GCP prerequisites list only 3 APIs (Agent Platform, IAM Credentials, Cloud Resource Manager), while the full guide lists 6. The omissions (Cloud Functions, Cloud Run, Secret Manager) are correct for the --skip-mint-check flow, but this is not explained. Users who later upgrade to a full install may be confused about missing APIs.
    Remediation: Add a brief note explaining that these 3 APIs are sufficient because --skip-mint-check skips mint-related GCP provisioning, and point to the full guide for additional APIs needed in other installation modes.

Previous run

Review

Findings

High

  • [content-security] docs/guides/admin/install.md:61 — Hardcoded Cloud Run URL (fullsend-mint-gljhbkcloq-uc.a.run.app) in install commands (lines 61 and 68). CLAUDE.md explicitly prohibits committing internal hostnames. The existing installation.md guide uses $MINT_URL and $PLATFORM_MINT_URL variable placeholders — this guide should follow the same pattern.
    Remediation: Replace the hardcoded URL with a variable. Add export MINT_URL="<your-mint-url>" to the export section (line 52) and use --mint-url=$MINT_URL in both install commands.

Low

  • [correctness] docs/guides/admin/install.md:14 — Grammar error: "Fullsend needs a GCP Project to connect run the inference" — extra word "connect" makes the sentence unclear.
    Remediation: Change to "Fullsend needs a GCP project to run inference" or "Fullsend needs a GCP project to connect to and run inference."

  • [correctness] docs/guides/admin/install.md:9 — Grammar error: "It is intended to a be simplified version" — word order is incorrect.
    Remediation: Change to "It is intended to be a simplified version".

Previous run (2)

Review

Findings

High

  • [content-security] docs/guides/admin/install.md:61 — Hardcoded Cloud Run URL (fullsend-mint-gljhbkcloq-uc.a.run.app) in install commands. CLAUDE.md explicitly prohibits committing internal hostnames. The existing installation.md guide uses $MINT_URL as a variable placeholder — this guide should follow the same pattern.
    Remediation: Replace the hardcoded URL with a variable (e.g., $MINT_URL) and add it to the export section with a placeholder like export MINT_URL="<your-mint-url>".

Medium

  • [correctness] docs/guides/admin/install.md:61 — Variable name mismatch: the export section (line 52) defines GCP_PROJECT but the install commands on lines 61 and 69 reference $GCP_PROJECT_NAME, which is never defined. This will cause the commands to silently expand to an empty string.
    Remediation: Change $GCP_PROJECT_NAME to $GCP_PROJECT in both install commands, or rename the export to GCP_PROJECT_NAME.

  • [correctness] docs/guides/admin/install.md:10 — Broken link: [/reference/install.md] uses reference-link syntax without a defined reference, and the target path docs/reference/ does not exist in the repository. The link renders as plain text and leads nowhere.
    Remediation: Either create the referenced document, link to the existing installation.md guide (e.g., [installation reference](installation.md)), or remove the reference until the target exists.

Low

  • [style] docs/guides/admin/install.md:10 — Typo: "refernce" should be "reference".

  • [correctness] docs/guides/admin/install.md:72 — Incomplete sentence: "This creates the appropriate secrets, variables and files in your organization and provides." — the sentence appears truncated after "provides".
    Remediation: Complete the sentence or remove the trailing "and provides".

  • [style] docs/guides/README.md:11 — Style inconsistency: the new entry uses - (hyphen) as a description separator while existing entries use (em dash). Match the existing convention for consistency.

Copy link
Copy Markdown

@fullsend-ai-review fullsend-ai-review Bot left a comment

Choose a reason for hiding this comment

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

See the review comment for full details.

Comment thread docs/guides/admin/install.md
Comment thread docs/guides/admin/install.md
Comment thread docs/guides/admin/install.md Outdated
Comment thread docs/guides/admin/install.md Outdated
Comment thread docs/guides/admin/install.md
Comment thread docs/guides/README.md Outdated
@rh-hemartin rh-hemartin self-assigned this May 26, 2026
rh-hemartin and others added 2 commits May 27, 2026 08:01
- Fix GCP_PROJECT_NAME -> GCP_PROJECT variable mismatch
- Fix em dash separator in README.md

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Signed-off-by: Hector Martinez <[email protected]>
Copy link
Copy Markdown

@fullsend-ai-review fullsend-ai-review Bot left a comment

Choose a reason for hiding this comment

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

See the review comment for full details.

Comment thread docs/guides/admin/install.md
Comment thread docs/guides/admin/install.md
Comment thread docs/guides/admin/install.md Outdated
Signed-off-by: Hector Martinez <[email protected]>
@rh-hemartin
Copy link
Copy Markdown
Contributor Author

Closing due installation changing a lot in the last few PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant