Skip to content

docs: updated documentation for multiple pages #658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/init.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Initialize a new project directory with boilerplate files."

# `preswald init <project_name>`

The `preswald init` command initializes a new project directory and generates boilerplate files to get started quickly.
The `preswald init` command initializes a new project directory and generates the boilerplate files to get you started quickly.

## Arguments

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Run a tutorial preswald project bundled with the package."

# `preswald tutorial`

The `preswald tutorial` command starts up a local preswald server for a tutorial app.
The `preswald tutorial` command launches a local development server with a pre-configured tutorial application to help you learn how to use the Preswald framework..

## Example Usage

Expand Down
2 changes: 2 additions & 0 deletions docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
- `title`: Name of the app displayed in the interface.
- `version`: Version of the app.
- `port`: Port the app runs on (default is `8501`).
- `slug`: A URL-friendly identifier used to access the app in the browser.
- `entrypoint`: The main Python file that serves as the entry point for the app.

### `[branding]`

Expand Down
90 changes: 48 additions & 42 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,75 +8,81 @@ description: "Get up and running with the Preswald SDK in under 5 minutes"

<Step title="Install the Preswald SDK">

```bash
pip install preswald
```bash
pip install preswald

or
or

uv pip install preswald
```
uv pip install preswald
```

<Tip>Need the latest version? Upgrade anytime:</Tip>
<Tip>Need the latest version? Upgrade Preswald anytime using:</Tip>

```bash
pip install --upgrade preswald
```bash
pip install --upgrade preswald

or
or

uv pip install --upgrade preswald
```

</Step>
uv pip install --upgrade preswald
```
</Step>

<Step title="Set Up Your First Project">

Run these commands to bootstrap your first Preswald app:
Run these commands to bootstrap your first Preswald app:

```bash
preswald init my_project
cd my_project
```
```bash
preswald init my_project
cd my_project
```

This will create a scaffolded project with the following:
This will create a scaffolded project with the following:

- **`hello.py`**: A starter Python script to get you going.
- **`preswald.toml`**: Your app’s configuration settings.
- **`secrets.toml`**: A secure place for sensitive data.
- **`.gitignore`**: Pre-configured to exclude sensitive files from version control.
- **`hello.py`**: A starter Python script to get you going.
- **`preswald.toml`**: Your app’s configuration settings.
- **`secrets.toml`**: A secure place for sensitive data.
- **`.gitignore`**: Pre-configured to exclude sensitive files from version control.

</Step>
</Step>

<Step title="Write Your First App">

Open `hello.py` and edit it with the following content:
Open `hello.py` and edit it with the following content:

```python
from preswald import text
```python
from preswald import text

text("# Welcome to Preswald")
```
text("# Welcome to Preswald")
```

#### Run It Locally
#### Run It Locally

Launch your app locally with this command:
Launch your app locally with this command:

```bash
preswald run
```
```bash
preswald run
```

Open your browser and navigate to **[http://localhost:8501](http://localhost:8501)**. Your app will be live, ready for you to explore and iterate on.
Open your browser and navigate to **[http://localhost:8501](http://localhost:8501)**. Your app will be live, ready for you to explore and iterate on.

</Step>
</Step>

<Step title="Deploy Your App">

When you're ready to deploy your app, run this:
When you're ready to deploy your app, run the following command:

```bash
preswald deploy --target structured
```

</Step>

<Step>

You will be prompted to pass in your GitHub username and Preswald API key. Get the preswald API key from our [cloud console](https://app.preswald.com/). Click on your organization name > Manage > API Keys.

```bash
preswald deploy --target structured
```
</Step>
<Tip>To simplify the deployment process, we're moving away from API keys to one-click deployment soon!</Tip>

You will be prompted to pass in your GitHub username and Preswald API key. Get the preswald API key from our [cloud console](https://app.preswald.com/). Click on Organization name > Manage > API Keys.
</Step>

</Steps>
2 changes: 1 addition & 1 deletion docs/sdk/text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ text("This is a **formatted text** example using Markdown.")

The `text` function supports the full range of Markdown syntax, including:

- **Headers**: `#` for H1, `##` for H2, and so on.
- **Headers**: `#` for H1, `##` for H2, continuing up to `####` for H4.
- **Emphasis**: `*italic*`, `**bold**`, `~~strikethrough~~`.
- **Lists**:
- Unordered: `- Item 1`, `- Item 2`
Expand Down