From ec9c3cb92817ba3dde329f48e3ff18f35f80c7df Mon Sep 17 00:00:00 2001 From: sethjuarez Date: Fri, 7 Jun 2024 22:26:43 -0700 Subject: [PATCH 1/3] added additional readme information --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index aa00f3e..4b4c33f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ 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. +This repo contains the following: + +- [Prompty Language Specification](Prompty.yaml) +- [Documentation](https://github.com/microsoft/prompty/tree/main/web) site (visit [prompty.ai](https://prompty.ai) for the live site) +- (More on the way) + This Visual Studio Code extension offers an intuitive prompt playground within VS Code to streamline the prompt engineering process. You can find the Pormpty extension in the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.prompty). ## What is Prompty? From 5890b1396cd0edce77d6b744853929b81a330d8b Mon Sep 17 00:00:00 2001 From: sethjuarez Date: Fri, 7 Jun 2024 22:29:05 -0700 Subject: [PATCH 2/3] documentation readme --- web/README.md | 38 ++++---------------------------------- 1 file changed, 4 insertions(+), 34 deletions(-) diff --git a/web/README.md b/web/README.md index c403366..71537da 100644 --- a/web/README.md +++ b/web/README.md @@ -1,36 +1,6 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Prompty Website +This contains the main website for the Prompty project. The website is built using [Next.js](https://nextjs.org). -## Getting Started +## Contributing Documentation -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +Instructions to follow. \ No newline at end of file From 2b8412fecc748915d5fc73cb30e8b5271cc5b4f1 Mon Sep 17 00:00:00 2001 From: sethjuarez Date: Fri, 7 Jun 2024 22:29:50 -0700 Subject: [PATCH 3/3] added site url --- web/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/README.md b/web/README.md index 71537da..1a84b09 100644 --- a/web/README.md +++ b/web/README.md @@ -1,6 +1,6 @@ # Prompty Website -This contains the main website for the Prompty project. The website is built using [Next.js](https://nextjs.org). +This contains the [main website](https://prompty.ai) for the Prompty project. The website is built using [Next.js](https://nextjs.org). ## Contributing Documentation -Instructions to follow. \ No newline at end of file +Instructions to follow... \ No newline at end of file