Skip to content

Conversation

@TabishB
Copy link
Contributor

@TabishB TabishB commented Jan 20, 2026

Summary

  • Add documentation for configuring OpenSpec to output artifacts in languages other than English
  • Uses existing context field in config.yaml - no code changes needed
  • Includes examples for Portuguese, Spanish, Chinese, Japanese, French, and German
  • Notes that a dedicated language field may be added in a future release

Test plan

  • Verified language instructions appear in artifact output by temporarily modifying openspec/config.yaml and running openspec instructions
  • Review documentation for clarity and accuracy

🤖 Generated with Claude Code

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 20, 2026

Warning

Rate limit exceeded

@TabishB has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 32 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8332a09 and 31c78a5.

📒 Files selected for processing (1)
  • docs/multi-language-output.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Document how to configure OpenSpec to generate artifacts in languages
other than English using the existing context field in config.yaml.

Includes examples for Portuguese, Spanish, Chinese, Japanese, French,
and German, plus tips for handling technical terminology.
@TabishB TabishB force-pushed the docs/multi-language-output branch from d2d6ac7 to 31c78a5 Compare January 20, 2026 08:55
@vibe-kanban-cloud
Copy link

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

@greptile-apps
Copy link

greptile-apps bot commented Jan 20, 2026

Greptile Summary

This PR adds documentation for configuring OpenSpec to output artifacts in languages other than English. The guide leverages the existing context field in openspec/config.yaml without requiring any code changes.

Key additions:

  • Quick setup instructions showing how to add language instructions to the context field
  • Examples for 6 languages: Portuguese (Brazil), Spanish, Chinese (Simplified), Japanese, French, and German
  • Technical explanation of how the context field is injected as XML into artifact instructions
  • Best practices for handling technical terminology and scope
  • Verification steps to confirm language settings are working
  • Links to related documentation (project config and experimental workflow guides)

The documentation is accurate - I verified against the codebase that the context field is indeed injected into instructions via the instruction-loader.ts module (lines 255-258), wrapped in <context> XML tags. The approach is sound and the examples are clear and practical.

Confidence Score: 5/5

  • This PR is safe to merge with no issues found
  • This is a documentation-only change that adds a new guide file without modifying any code. The documentation accurately describes existing functionality (verified against the codebase), provides clear examples, and follows the project's documentation structure by linking to related guides.
  • No files require special attention

Important Files Changed

Filename Overview
docs/multi-language-output.md Added comprehensive guide for configuring multi-language output using the existing context field in project config

Sequence Diagram

sequenceDiagram
    participant User
    participant Config as openspec/config.yaml
    participant CLI as OpenSpec CLI
    participant Loader as Instruction Loader
    participant AI as AI Assistant

    User->>Config: Add language instruction to context field
    Note over Config: context: |<br/>  Language: Portuguese (pt-BR)<br/>  All artifacts must be in Portuguese.

    User->>CLI: openspec instructions proposal --change my-feature
    CLI->>Loader: loadChangeContext()
    Loader->>Config: readProjectConfig()
    Config-->>Loader: Return config with context field
    
    Loader->>Loader: generateInstructions()
    Note over Loader: Inject context as XML block:<br/><context>..context..</context>
    
    Loader-->>CLI: Return enriched template
    CLI-->>User: Display instructions with context
    
    User->>AI: Generate artifact using instructions
    AI->>AI: Process instructions including language context
    AI-->>User: Generate artifact in Portuguese
Loading

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