langchain-ai/langsmith-docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/langsmith-docs.git synced 2026-07-15 11:55:38 -04:00
Code Issues 16 Packages Projects Releases Wiki Activity

[PR #894] feat: add new prompt best practices section #869

New Issue
Open
opened 2026-02-21 17:19:06 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 17:19:06 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/langsmith-docs/pull/894
Author: @PeriniM
Created: 7/8/2025
Status: 🔄 Open

Base: main ← Head: marco/best-practices-prompt

📝 Commits (10+)

  • 12558e1 feat: add new prompt best practices section
  • 2c95f9c Update docs/prompt_engineering/tutorials/best_practices.mdx
  • 3f04124 Update docs/prompt_engineering/tutorials/best_practices.mdx
  • 95b8d1f Update docs/prompt_engineering/tutorials/best_practices.mdx
  • 5fec635 Update docs/prompt_engineering/tutorials/best_practices.mdx
  • 9be8527 Update docs/prompt_engineering/tutorials/best_practices.mdx
  • fe2ecc9 Update docs/prompt_engineering/tutorials/best_practices.mdx
  • 9b7c0d9 Update docs/prompt_engineering/tutorials/best_practices.mdx
  • 2412e87 Update docs/prompt_engineering/tutorials/best_practices.mdx
  • ca62b96 docs(prompts): integrated review

📊 Changes

6 files changed (+137 additions, -1 deletions)

View changed files

📝 docs/index.mdx (+2 -1)
➕ docs/prompt_engineering/tutorials/best_practices.mdx (+134 -0)
📝 docs/prompt_engineering/tutorials/index.mdx (+1 -0)
➕ docs/prompt_engineering/tutorials/static/prompt-best-practice-cicd.png (+0 -0)
➕ docs/prompt_engineering/tutorials/static/prompt-best-practice-git.png (+0 -0)
➕ docs/prompt_engineering/tutorials/static/prompt-best-practice-sequence.png (+0 -0)

📄 Description

sequenceDiagram
    participant User
    participant LangSmith
    participant Intermediary Service
    participant GitHub Repo

    User->>LangSmith: Commits new prompt version
    activate LangSmith
    LangSmith->>Intermediary Service: Fires Webhook (sends prompt data)
    deactivate LangSmith
    activate Intermediary Service
    Intermediary Service->>GitHub Repo: Commits new prompt file via API
    activate GitHub Repo
    GitHub Repo-->>Intermediary Service: Confirms commit
    deactivate GitHub Repo
    Intermediary Service-->>LangSmith: Responds with success (optional)
    deactivate Intermediary Service

gitGraph
    commit id: "v1.0"
    branch develop
    checkout develop
    commit id: "feat: new idea"
    commit id: "fix: refine idea" tag: "dev"
    checkout main
    merge develop id: "Release v2.0" tag: "staging" tag: "prod"
    checkout develop
    commit id: "feat: another feature"

graph TD
    subgraph Trigger
        A[Commit New Prompt Version];
    end

    subgraph "CI: Automated Testing"
        B(Step 1: Linting & Validation);
        C(Step 2: Unit Tests);
        D(Step 3: Run Evals on Dataset);
    end

    subgraph "CD: Automated Deployment"
        E{Evals Pass & Score Improves?};
        F[Auto-Promote to 'staging'];
        G[Fail & Alert Team];
        H[Manual Review of Staging];
        I[Promote to 'prod'];
    end

    A --> B;
    B --> C;
    C --> D;
    D --> E;
    E -- Yes --> F;
    E -- No --> G;
    F --> H;
    H --> I;

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/langsmith-docs/pull/894 **Author:** [@PeriniM](https://github.com/PeriniM) **Created:** 7/8/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `marco/best-practices-prompt` --- ### 📝 Commits (10+) - [`12558e1`](https://github.com/langchain-ai/langsmith-docs/commit/12558e176bd49683dd599d06e222535066132ba1) feat: add new prompt best practices section - [`2c95f9c`](https://github.com/langchain-ai/langsmith-docs/commit/2c95f9c8127f4554f077909bb4d2e08c27962b9b) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`3f04124`](https://github.com/langchain-ai/langsmith-docs/commit/3f04124f66bf1ed4cf4cf9073e1b8bfa723f6cd1) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`95b8d1f`](https://github.com/langchain-ai/langsmith-docs/commit/95b8d1f7d2aa896b363d4983e34286cc100b8379) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`5fec635`](https://github.com/langchain-ai/langsmith-docs/commit/5fec635dabe4e266cf449d09bf18d7dcfaeb5286) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`9be8527`](https://github.com/langchain-ai/langsmith-docs/commit/9be8527e54996c8df497a5ed0c727c9ff4df7d7c) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`fe2ecc9`](https://github.com/langchain-ai/langsmith-docs/commit/fe2ecc929ccf6fb8cec42a83f02c7571c0220bde) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`9b7c0d9`](https://github.com/langchain-ai/langsmith-docs/commit/9b7c0d983085cca8a276d6bfa1ffdaa4ad2e848b) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`2412e87`](https://github.com/langchain-ai/langsmith-docs/commit/2412e870851ec21addc872c1582831fa8851c986) Update docs/prompt_engineering/tutorials/best_practices.mdx - [`ca62b96`](https://github.com/langchain-ai/langsmith-docs/commit/ca62b9681a19ea409874752fee6e107df12b647e) docs(prompts): integrated review ### 📊 Changes **6 files changed** (+137 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/index.mdx` (+2 -1) ➕ `docs/prompt_engineering/tutorials/best_practices.mdx` (+134 -0) 📝 `docs/prompt_engineering/tutorials/index.mdx` (+1 -0) ➕ `docs/prompt_engineering/tutorials/static/prompt-best-practice-cicd.png` (+0 -0) ➕ `docs/prompt_engineering/tutorials/static/prompt-best-practice-git.png` (+0 -0) ➕ `docs/prompt_engineering/tutorials/static/prompt-best-practice-sequence.png` (+0 -0) </details> ### 📄 Description ```mermaid sequenceDiagram participant User participant LangSmith participant Intermediary Service participant GitHub Repo User->>LangSmith: Commits new prompt version activate LangSmith LangSmith->>Intermediary Service: Fires Webhook (sends prompt data) deactivate LangSmith activate Intermediary Service Intermediary Service->>GitHub Repo: Commits new prompt file via API activate GitHub Repo GitHub Repo-->>Intermediary Service: Confirms commit deactivate GitHub Repo Intermediary Service-->>LangSmith: Responds with success (optional) deactivate Intermediary Service ``` ```mermaid gitGraph commit id: "v1.0" branch develop checkout develop commit id: "feat: new idea" commit id: "fix: refine idea" tag: "dev" checkout main merge develop id: "Release v2.0" tag: "staging" tag: "prod" checkout develop commit id: "feat: another feature" ``` ```mermaid graph TD subgraph Trigger A[Commit New Prompt Version]; end subgraph "CI: Automated Testing" B(Step 1: Linting & Validation); C(Step 2: Unit Tests); D(Step 3: Run Evals on Dataset); end subgraph "CD: Automated Deployment" E{Evals Pass & Score Improves?}; F[Auto-Promote to 'staging']; G[Fail & Alert Team]; H[Manual Review of Staging]; I[Promote to 'prod']; end A --> B; B --> C; C --> D; D --> E; E -- Yes --> F; E -- No --> G; F --> H; H --> I; ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-21 17:19:06 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langsmith-docs#869
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?