feat: add new prompt best practices section

[PeriniM]

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

Loading

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"

Loading

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;

Loading

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
langsmith-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 14, 2025 1:08pm

[katmayb]

Hi @PeriniM, Tanushree sent me this PR to take a look through while I ramp up on LangSmith docs. I made some suggestions — I hope these are helpful. Lmk if you have any questions! cc @tanushree-sharma

[katmayb]

Since this is a best practices guide, maybe adding a link to this new page in the Get Started page (here) would be helpful for users to review when looking at the prompt engineering links.