Skip to content

[codex] docs: add Arabic SOP documentation#67

Open
8bnns wants to merge 134 commits into
meta-llama:name-migrationfrom
8bnns:codex/arabic-sop-docs
Open

[codex] docs: add Arabic SOP documentation#67
8bnns wants to merge 134 commits into
meta-llama:name-migrationfrom
8bnns:codex/arabic-sop-docs

Conversation

@8bnns
Copy link
Copy Markdown

@8bnns 8bnns commented May 5, 2026

Summary

This PR adds comprehensive Arabic (العربية) Standard Operating Procedure (SOP) documentation to prompt-ops, mirroring the full existing English docs structure under a new docs/ar/ directory.

What's Added

A new docs/ar/ directory containing Arabic translations of all four documentation guides:

  • docs/ar/README.md — البدء السريع (Getting Started): overview of adapters, metrics, supported formats, and inference providers
  • docs/ar/basic/readme.md — دليل البدء السريع (Quick Start Guide): step-by-step 5-minute walkthrough for the Facility Support Analyzer use case
  • docs/ar/intermediate/readme.md — دليل تهيئة YAML (YAML Configuration Guide): deep dive into all YAML config sections (model, dataset, prompt, metric, optimization)
  • docs/ar/advanced/readme.md — المحوّلات والمقاييس المخصصة (Custom Adapters & Metrics): how to build custom dataset adapters and evaluation metrics with a full customer-service classification example

Changes to Existing Files

  • docs/README.md: Added a "Documentation Languages / لغات التوثيق" section with a language switcher linking to the Arabic docs

Implementation Details

  • All Arabic files use <div dir="rtl"> wrappers for proper right-to-left rendering
  • YAML frontmatter is translated into Arabic (title, category, description)
  • Code blocks, CLI commands, and YAML snippets remain in their original form for technical accuracy
  • Internal links between Arabic docs are correctly cross-referenced

Co-Authored-By: Oz oz-agent@warp.dev

…rchitecture

- Replace OpenAI client with OpenRouter across all endpoints
- Implement enhance_prompt_with_openrouter shared function for DRY architecture
- Add advanced CoT-based system message for enhanced prompt engineering
- Change default mode from 'enhance' to 'migrate' in frontend
- Add experimental badge to enhance option in UI
- Fix sliding indicator positioning with CSS Grid layout
- Consolidate fallback migration to use same enhancement logic
- Update API key handling for OPENROUTER_API_KEY throughout system
…rchitecture

- Replace OpenAI client with OpenRouter across all endpoints
- Implement enhance_prompt_with_openrouter shared function for DRY architecture
- Add advanced CoT-based system message for enhanced prompt engineering
- Change default mode from 'enhance' to 'migrate' in frontend
- Add experimental badge to enhance option in UI
- Fix sliding indicator positioning with CSS Grid layout
- Consolidate fallback migration to use same enhancement logic
- Update API key handling for OPENROUTER_API_KEY throughout system
heyjustinai and others added 16 commits December 18, 2025 16:22
…and frontend components for improved user experience
…rporate useDefaultKey flag for API key handling, improving configuration management and validation logic.
…nents by adding ARIA attributes and updating text color for better visibility
…instructions; change backend port to 8001 for consistency.
Remove execution outputs from all cells in PDO web of lies evaluation notebook and update kernel metadata to reflect Python 3.14.4 environment.
- Add docs/ar/ with full Arabic translations of all guides:
  - docs/ar/README.md (Getting Started / البدء السريع)
  - docs/ar/basic/readme.md (Quick Start / دليل البدء السريع)
  - docs/ar/intermediate/readme.md (YAML Config / تهيئة YAML)
  - docs/ar/advanced/readme.md (Custom Adapters / المحوّلات المخصصة)
- Add language switcher in docs/README.md linking to Arabic docs
- All Arabic files use RTL dir attribute and Arabic frontmatter

Co-Authored-By: Oz <oz-agent@warp.dev>
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 5, 2026

Hi @8bnns!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

8bnns and others added 3 commits May 6, 2026 02:28
- Add Arabic translations of remaining guides:
  - docs/ar/dataset_adapter_selection_guide.md
  - docs/ar/metric_selection_guide.md
  - docs/ar/inference_providers.md
- Fix internal links in docs/ar/ to point to Arabic versions
  instead of English counterparts

Co-Authored-By: Oz <oz-agent@warp.dev>
@8bnns 8bnns marked this pull request as ready for review May 10, 2026 09:10
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented May 10, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label May 10, 2026
Copy link
Copy Markdown
Author

@8bnns 8bnns left a comment

Choose a reason for hiding this comment

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

The

@8bnns 8bnns marked this pull request as draft May 11, 2026 05:48
@8bnns 8bnns marked this pull request as ready for review May 11, 2026 05:48
@8bnns 8bnns marked this pull request as draft May 12, 2026 13:54
@8bnns 8bnns marked this pull request as ready for review May 12, 2026 13:54
Copy link
Copy Markdown
Author

@8bnns 8bnns left a comment

Choose a reason for hiding this comment

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

اكمل

@8bnns 8bnns changed the base branch from main to name-migration May 13, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants