Skip to content

docs: note experimental Fystash Harbor environment.type - #1946

Open
fystash wants to merge 2 commits into
NovaSky-AI:mainfrom
fystash:docs-fystash-harbor
Open

docs: note experimental Fystash Harbor environment.type#1946
fystash wants to merge 2 commits into
NovaSky-AI:mainfrom
fystash:docs-fystash-harbor

Conversation

@fystash

@fystash fystash commented Jul 27, 2026

Copy link
Copy Markdown

Summary

  • Documents experimental harbor_trial_config.environment.type=fystash on the Harbor integration page (credentials + config table + launch comment).
  • Notes Fystash in the default Harbor trial config option list comment.
  • Depends on Harbor shipping --env fystash (harbor#2491); SkyRL’s pinned Harbor rev may also need a bump after that merge.
  • How-to: https://docs.fystash.ai/guides/skyrl

Docs-only — no SkyRL generator or Harbor pin change in this PR.

Test plan

  • Harbor docs page renders
  • environment.type table lists fystash as experimental
  • Quick-start credentials show commented FYSTASH_API_KEY

Made with Cursor

Document fystash as an experimental Harbor sandbox option for SkyRL
trials (FYSTASH_API_KEY; requires Harbor --env fystash).

Signed-off-by: clayton-dcruze <clayhenrydecruze@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation and configuration support for the experimental Fystash sandbox provider in Harbor. The changes update the environment variables, provider lists, and prerequisites in the documentation and default YAML configuration. The review feedback highlights a critical syntax error where a commented line inside a backslash-escaped bash command would cause the rest of the command to be ignored, and suggests adding the FYSTASH_TEMPLATE_ID environment variable to the quick start credentials section for completeness.

Comment thread docs/content/docs/harbor/index.mdx Outdated
Comment on lines +388 to +389
harbor_trial_config.environment.type=daytona \
# harbor_trial_config.environment.type=fystash \ # experimental; Harbor Fystash + FYSTASH_API_KEY

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Placing a comment starting with # inside a multi-line backslash-escaped (\) bash command is a syntax error / unexpected behavior in bash. Because the previous line ends with \, the newline is escaped, and the comment character # comments out the rest of the line. Furthermore, because the comment line itself ends with \, it escapes the next newline, causing the entire rest of the command (such as trainer.algorithm.max_seq_len=32768 \ and subsequent lines) to be treated as part of the comment and ignored. This will break the command when users copy and paste it.

  harbor_trial_config.environment.type=daytona \

Comment on lines +20 to +21
# export FYSTASH_API_KEY=your_fystash_api_key # experimental; needs Harbor --env fystash
# export FYSTASH_API=https://api.fystash.ai

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Since the configuration section below mentions that Fystash uses FYSTASH_TEMPLATE_ID from the environment, it would be helpful to also include it as a commented-out export in the Quick Start credentials section to make the setup instructions complete and consistent.

# export FYSTASH_API_KEY=your_fystash_api_key   # experimental; needs Harbor --env fystash
# export FYSTASH_TEMPLATE_ID=your_fystash_template_id
# export FYSTASH_API=https://api.fystash.ai

Gemini review: a # comment inside a \\-continued command comments out the
rest of the training invocation. Move the fystash swap to its own snippet
and document FYSTASH_TEMPLATE_ID in Quick Start credentials.

Co-authored-by: Cursor <cursoragent@cursor.com>
@fystash

fystash commented Jul 27, 2026

Copy link
Copy Markdown
Author

Thanks for the review feedback (gemini-code-assist) — addressed in the latest push:

  1. Bash \\ + # comment — removed the inline commented environment.type=fystash from inside the continued uv run block (it was commenting out the rest of the command). Fystash is now a short follow-on snippet.
  2. FYSTASH_TEMPLATE_ID — added as a commented export next to FYSTASH_API_KEY / FYSTASH_API in Quick Start.

Happy to tweak further if maintainers prefer a different docs shape. Depends on Harbor harbor#2491 for the actual --env fystash provider.

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.

2 participants