Skip to content
Merged
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
14 changes: 12 additions & 2 deletions assets/docs/getting-started/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,23 @@ order: 3

Use the buridan CLI to add components, apply themes, and manage your Buridan UI project.

All commands must be run from your Reflex project root, where `rxconfig.py` is located.

# Installation

Add `buridan` to your `pyproject.toml`:

```toml
dependencies = ["buridan=={current version}"]
```

Then sync your environment with [uv](https://docs.astral.sh/uv/):

```bash
pip install buridan-create
uv sync
```

All commands must be run from your Reflex project root, where `rxconfig.py` is located.
See the [Installation](/docs/getting-started/installation) page for the full setup guide.

# create

Expand Down
25 changes: 18 additions & 7 deletions assets/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ order: 1

How to install dependencies and structure your app.

>Recommended for new projects: Use [buridan/create](/create) to build your preset visually and generate the right setup command for your framework.
> Recommended for new projects: Use [buridan/create](/create) to build your preset visually and generate the right setup command for your framework.

# Use buridan/create

Expand All @@ -18,23 +18,34 @@ Build your preset visually, preview your choices, and generate a framework-speci

Python 3.10+ (required by Reflex)

# Local Environment
# Local Environment

It's recommended to use the [uv](https://docs.astral.sh/uv/) package manager when working with Reflex apps.
It's recommended to use the [uv](https://docs.astral.sh/uv/) package manager when working with Reflex apps.

The following page provides a step-by-step [installation](https://reflex.dev/docs/getting-started/installation/) guide for Reflex apps.
The following page provides a step-by-step [installation](https://reflex.dev/docs/getting-started/installation/) guide for Reflex apps. Buridan is installed into an existing Reflex project, so make sure you have a project with an `rxconfig.py` at its root before continuing. Every `buridan` command needs to be run from that project root.

After setting up your Reflex environment, you can install the `buridan` package by adding it to your `pyproject.toml` file.

```toml
dependencies = ["buridan-create=={current version}"]
dependencies = ["buridan=={current version}"]
```

After adding the package with the latest version, you can run the following command to install it.
You can find the latest published version on [PyPI](https://pypi.org/project/buridan/).

After adding the package, sync your environment with uv:

```bash
uv sync
```

Installing it will give access to the full [CLI](/docs/getting-started/cli) tool.
Installing it will give access to the full [CLI](/docs/getting-started/cli) tool. To confirm everything is set up correctly, run:

```bash
buridan init
```

This sets up the CSS utilities and Tailwind configuration Buridan needs, and confirms the CLI is installed and working. From here, see the [CLI docs](/docs/getting-started/cli) for the recommended workflow to apply a theme and start adding components.

# Troubleshooting

If `uv sync` or a manual `pip install` fails with `error: externally-managed-environment`, you're likely installing against your system Python rather than a project-scoped environment. Using `uv sync` inside a Reflex project set up per the guide above avoids this. If you're not using uv, make sure you've activated a virtual environment first (`python3 -m venv .venv && source .venv/bin/activate`) before installing.
8 changes: 2 additions & 6 deletions assets/docs/getting-started/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,9 @@ For example, you can ask your AI assistant:

The skill gives your assistant knowledge about your project's configuration, installed components, CLI workflow, theming system, and recommended architecture patterns.

# Install
# Using Skills

```bash
uv add add buridan
```

This installs the Buridan skill into your project. Once installed, supported AI assistants automatically load Buridan-specific guidance when working with your project.
Buridan Skills are included with the repository and do not require separate installation. They are located in the `.agents/skills/` directory. When working within the project, your AI assistant automatically loads this guidance.

# What's Included

Expand Down
14 changes: 12 additions & 2 deletions docs/getting_started/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,23 @@ order: 3

Use the buridan CLI to add components, apply themes, and manage your Buridan UI project.

All commands must be run from your Reflex project root, where `rxconfig.py` is located.

# Installation

Add `buridan` to your `pyproject.toml`:

```toml
dependencies = ["buridan=={current version}"]
```

Then sync your environment with [uv](https://docs.astral.sh/uv/):

```bash
pip install buridan-create
uv sync
```

All commands must be run from your Reflex project root, where `rxconfig.py` is located.
See the [Installation](/docs/getting-started/installation) page for the full setup guide.

# create

Expand Down
25 changes: 18 additions & 7 deletions docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ order: 1

How to install dependencies and structure your app.

>Recommended for new projects: Use [buridan/create](/create) to build your preset visually and generate the right setup command for your framework.
> Recommended for new projects: Use [buridan/create](/create) to build your preset visually and generate the right setup command for your framework.

# Use buridan/create

Expand All @@ -18,23 +18,34 @@ Build your preset visually, preview your choices, and generate a framework-speci

Python 3.10+ (required by Reflex)

# Local Environment
# Local Environment

It's recommended to use the [uv](https://docs.astral.sh/uv/) package manager when working with Reflex apps.
It's recommended to use the [uv](https://docs.astral.sh/uv/) package manager when working with Reflex apps.

The following page provides a step-by-step [installation](https://reflex.dev/docs/getting-started/installation/) guide for Reflex apps.
The following page provides a step-by-step [installation](https://reflex.dev/docs/getting-started/installation/) guide for Reflex apps. Buridan is installed into an existing Reflex project, so make sure you have a project with an `rxconfig.py` at its root before continuing. Every `buridan` command needs to be run from that project root.

After setting up your Reflex environment, you can install the `buridan` package by adding it to your `pyproject.toml` file.

```toml
dependencies = ["buridan-create=={current version}"]
dependencies = ["buridan=={current version}"]
```

After adding the package with the latest version, you can run the following command to install it.
You can find the latest published version on [PyPI](https://pypi.org/project/buridan/).

After adding the package, sync your environment with uv:

```bash
uv sync
```

Installing it will give access to the full [CLI](/docs/getting-started/cli) tool.
Installing it will give access to the full [CLI](/docs/getting-started/cli) tool. To confirm everything is set up correctly, run:

```bash
buridan init
```

This sets up the CSS utilities and Tailwind configuration Buridan needs, and confirms the CLI is installed and working. From here, see the [CLI docs](/docs/getting-started/cli) for the recommended workflow to apply a theme and start adding components.

# Troubleshooting

If `uv sync` or a manual `pip install` fails with `error: externally-managed-environment`, you're likely installing against your system Python rather than a project-scoped environment. Using `uv sync` inside a Reflex project set up per the guide above avoids this. If you're not using uv, make sure you've activated a virtual environment first (`python3 -m venv .venv && source .venv/bin/activate`) before installing.
8 changes: 2 additions & 6 deletions docs/getting_started/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,9 @@ For example, you can ask your AI assistant:

The skill gives your assistant knowledge about your project's configuration, installed components, CLI workflow, theming system, and recommended architecture patterns.

# Install
# Using Skills

```bash
uv add add buridan
```

This installs the Buridan skill into your project. Once installed, supported AI assistants automatically load Buridan-specific guidance when working with your project.
Buridan Skills are included with the repository and do not require separate installation. They are located in the `.agents/skills/` directory. When working within the project, your AI assistant automatically loads this guidance.

# What's Included

Expand Down
2 changes: 1 addition & 1 deletion native/templates/navbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def navbar(class_name: str = "") -> Header:
a(
button(
hi("GitBranchIcon", class_name="shrink-0 size-4"),
p("buridan@0.0.2", class_name="font-medium"),
p("buridan@0.0.3", class_name="font-medium"),
variant="ghost",
),
href="https://pypi.org/project/buridan/",
Expand Down
5 changes: 2 additions & 3 deletions native/templates/toc.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

import reflex as rx

from components.core.hugeicon import hi
Expand Down Expand Up @@ -67,8 +66,8 @@ def _create_markdown_toc_links(url: str, toc_data: list[dict]) -> rx.Component:
def _create_external_tool_links(url: str):
"""Create links for viewing documentation in external tools."""

fmt_url = "https://buridan-ui.reflex.run/" + url
prompt = f"""I'm looking at this buridan/ui documentation: {fmt_url}.
fmt_url = "https://native.buridan.dev/" + url
prompt = f"""I'm looking at this buridan/native documentation: {fmt_url}.
Help me understand how to use it. Be ready to explain concepts, give examples, or help debug based on it.
"""

Expand Down
Loading