Skip to content

Commit

Permalink
Merge pull request #41 from microsoft/docs-udpdate-july
Browse files Browse the repository at this point in the history
start of update for prompty docs homepage
  • Loading branch information
cassiebreviu authored Jul 17, 2024
2 parents 8493707 + 7713ba1 commit b4b610c
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 28 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
.DS_Store
*.js
*.js
runtime/promptycs/Prompty.Core/bin/
runtime/promptycs/Prompty.Core/obj/
runtime/promptycs/Tests/bin/
runtime/promptycs/Tests/obj/
39 changes: 37 additions & 2 deletions web/docs/page.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Prompty Documentation
title: Welcome to Prompty
description: This is the prompty documentation
authors:
- sethjuarez
Expand All @@ -11,4 +11,39 @@ tags:
date: 2024-06-10
---

Hi!
Prompty is an asset class and format for LLM prompts designed to enhance observability, understandability, and portability for developers. The primary goal is to accelerate the developer inner loop of prompt engineering and prompt source management in a cross-language and cross-platform implentation.

The file format has a supporting toolchain with a VS Code extension and runtimes in multiple programming languages to simplify and accelerate your A application development.

The tooling comes together in three ways: the *prompty file asset*, the *VS Code extension tool*, and *runtimes* in multiple programming languges.

## The Prompty File Format
Prompty is a language agnostic prompt asset for creating prompts and engineering the responses. Learn more about the format [here](../prompty-file-spec/page.mdx).

## The Prompty VS Code Extension
Run Prompty files directly in VS Code. This Visual Studio Code extension offers an intuitive prompt playground within VS Code to streamline the prompt engineering process. You can find the Prompty extension in the Visual Studio Code Marketplace.

Download the [VS Code extension here](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.prompty).


## The Prompty Runtimes

To execute a Prompty file asset in code, you can use one of the supporting runtimes such as:

* [Prompty Core (python)](https://pypi.org/project/prompty/) - The python Prompty core package is the base package needed to run a prompty asset file. Please note this package is preview and under active development.
* [Prompty Core (csharp)]() - Coming soon.
* [Promptyflow (python)](https://microsoft.github.io/promptflow/) - Use Prompty with Promptflow as your runtime and logic orchestrator.
* [LangChain (python)](https://pypi.org/project/langchain-prompty/) - Use the experimental LangChain Prompty runtime.
* [Semantic Kernal (csharp)](https://learn.microsoft.com/semantic-kernel/) - Use the experimental Semantic Kernal Prompty runtime.

**Note: We are continuing to work on the runtimes so watch for frequent updates!

### Learn more and get started building applications with Prompty
________________________
[Quick Start](./docs/getting-started/) - Coming soon.

[Tutorials](./docs/tutorials/) - Coming soon.

[Examples](https://learn.microsoft.com/en-us/collections/5pq0uompdgje8d) - Check out the AI App templates that were released at Microsoft Build that leverage Prompty for a variety of scenarios.

[Contributing](./docs/contributing/) - Coming soon.
25 changes: 0 additions & 25 deletions web/docs/what-is-prompty/page.mdx

This file was deleted.

Binary file removed web/docs/what-is-prompty/prompty32x32.png
Binary file not shown.

0 comments on commit b4b610c

Please sign in to comment.