Skip to content

Commit

Permalink
Merge pull request #559 from samjulien/docs-sample-app-lib
Browse files Browse the repository at this point in the history
Initial version of sample apps library
  • Loading branch information
ramedina86 authored Oct 3, 2024
2 parents 9f4af7b + 6a0ee4b commit 2926944
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/framework/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
title: "Quickstart"
---

## Install it and run the demo app
## Install Writer Framework and run the demo app

<Tip>
It works on Linux, Mac, and Windows. Python 3.9.2 or higher is required. We recommend using a virtual environment.
Writer Framework works on Linux, Mac, and Windows. Python 3.9.2 or higher is required. We recommend using a virtual environment.
</Tip>

<Steps>
<Step title="Install Framework">
Use the following command to install the necessary framework using `pip`. Open your command line interface and type:
<Step title="Install Writer Framework">
Use the following command to install the Writer Framework using `pip`. Open your command line interface and type:
```bash
pip install writer
```
Expand Down
37 changes: 37 additions & 0 deletions docs/framework/sample-apps.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Sample app library"
mode: "wide"
---
Writer Framework lets you build a wide variety of applications across different domains. Here are some sample apps to get you started, which are all [available on GitHub](https://github.com/writer/framework-tutorials/).

<Card title="Code generator" icon="code" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/code-generator" horizontal>
Generate React apps editable in a code sandbox.
</Card>

<Card title="Finance content checker" icon="file-invoice-dollar" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/finance-content-checker" horizontal>
Tool for analyzing financial content based on compliance guidelines.
</Card>

<Card title="Finance dashboard" icon="chart-line" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/finance-dashboard" horizontal>
AI-powered interactive dashboard for summarizing and visualizing financial data and metrics. Check out the [app tour](https://writer.com/engineering/financial-app-writer-framework-palmyra-fin/) on our Engineering blog.
</Card>

<Card title="Localized promo dashboard" icon="globe" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/localized-promo-dashboard" horizontal>
Tool to generate promotional content based on uploaded demographic data.
</Card>

<Card title="Patient portal" icon="hospital-user" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/patient-portal" horizontal>
Uses Palmyra-Med to generate SOAP notes and extract ICD codes from patient-doctor chat.
</Card>

<Card title="Product description embedded chat" icon="comments" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/pd-embedded-chat" horizontal>
Use an embedded no-code chat app to chat with a Knowledge Graph about products.
</Card>

<Card title="Product description page generator" icon="file-lines" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/pdp-generator" horizontal>
Tool for generating formatted product description pages.
</Card>

<Card title="Release notes generator" icon="clipboard-list" iconType="solid" href="https://github.com/writer/framework-tutorials/tree/main/release-notes-generator" horizontal>
Utility for creating formatted, downloadable release notes from CSVs containing GitLab notes. [Full tutorial here](./release-notes-generator).
</Card>
3 changes: 2 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
"framework/introduction",
"framework/quickstart",
"framework/ai-module",
"framework/cloud-deploy"
"framework/cloud-deploy",
"framework/sample-apps"
]
},
{
Expand Down

0 comments on commit 2926944

Please sign in to comment.