diff --git a/docs/getting_started/introduction.md b/docs/getting_started/introduction.md index 42e9f7c..49b7bf2 100644 --- a/docs/getting_started/introduction.md +++ b/docs/getting_started/introduction.md @@ -1,31 +1,23 @@ --- title: "Introduction" -description: "Overview of what Buridan UI is and how it works." +description: "An overview of Buridan UI, a component library for Reflex developers." order: 0 --- # Introduction -Welcome to a carefully curated collection of beautifully designed, highly accessible, and fully customizable components that you can effortlessly integrate into your applications. Whether you're a beginner or a seasoned developer, our components are built to be intuitive, scalable, and easy to use. Best of all, everything is open-source, meaning you have the freedom to modify and extend the components as needed. No more reliance on bulky libraries—just pure, flexible code at your fingertips. +Welcome to Buridan UI, a collection of beautifully designed, accessible, and customizable components built specifically for the [Reflex](https://reflex.dev/) framework. -# What makes this different? - -Unlike traditional component libraries that require you to install a package or add dependencies through tools like pip, this collection offers something entirely different. We don’t just hand you pre-built components and make you figure out how to fit them into your project. Instead, we provide a handpicked set of reusable components that are designed for easy integration, and you can simply copy and paste the code directly into your projects. No need for complicated installations or dependency management. - -This approach gives you the flexibility to quickly implement components in your app without worrying about version conflicts, updates, or unnecessary bloat. It’s a clean, efficient way to work, with a focus on flexibility and simplicity. +Buridan UI is not a typical Python package. Instead of installing a library and importing components you can't control, you add them directly to your project using our CLI. This makes the code yours, giving you the freedom to understand, modify, and extend it to fit your exact needs. -# How does it work? - -Using these components is as easy as choosing the ones you need, copying the code, and pasting it directly into your project. The code is yours to modify, improve, and extend to fit your exact needs—whether you're adjusting the styles to match your brand or adding custom functionality. - -Our goal is to give you complete control. We don’t lock you into a rigid system; instead, you get a set of foundational building blocks that are yours to adapt as you see fit. Whether you're building a small app or a large-scale enterprise solution, these components can scale with you, offering a flexible solution that fits your workflow. +# What makes this different? -# Installation and Setup +Inspired by the design of [shadcn/ui](https://ui.shadcn.com/), Buridan UI offers a unique approach to building user interfaces in your Reflex applications. -For more details on how to integrate the components into your project, check out our installation section. There, you'll find step-by-step guides and explanations for setting up everything from scratch. The setup process is simple, and you’ll be up and running in no time. +**You Own the Code**: Unlike traditional libraries, components are added directly to your project's directory, giving you full control over their code, styling, and behavior—no black boxes or hidden abstractions. It's **Built for Reflex**, designed from the ground up to integrate seamlessly with Reflex's architecture and state management. Our **CLI-Powered** approach means a simple command-line interface allows you to add components, themes, and dependencies effortlessly. Because the components become part of your codebase, they are **Fully Customizable**; you can tweak everything from styles to logic to match your brand and functionality perfectly. This means you can **Copy, Paste, and Extend** with ease: the CLI handles the heavy lifting of component integration, making it simple to find a component, add it to your project, and start building. -# An Essential Reference for Python Developers +# An Essential Toolkit for Reflex Developers -Think of this collection as not just a set of components but as a valuable resource to inspire and guide you in creating your own component libraries. It provides clear, understandable examples of how reusable UI elements can be structured, customized, and adapted for various applications. It’s a great starting point if you're looking to build something from the ground up or enhance an existing project. +Think of Buridan UI as a starter kit and a powerful resource for your Reflex projects. It provides well-structured, reusable UI elements that save you time and effort. Whether you're building a quick prototype or a large-scale application, these components provide a solid foundation, allowing you to focus on what makes your project unique. -By using this as your foundation, you can avoid reinventing the wheel while still maintaining full creative control over your project’s UI. Happy coding, and enjoy the process of building clean, well-designed applications! +Ready to get started? Check out the [Installation](./installation.md) guide to set up the CLI and add your first component. diff --git a/docs/getting_started/who_is_buridan.md b/docs/getting_started/who_is_buridan.md deleted file mode 100644 index 6d7a648..0000000 --- a/docs/getting_started/who_is_buridan.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Who is Buridan?" -description: "A brief backstory on Buridan and the philosophy behind the framework." -order: 1 ---- - -# Who is Buridan? - -Jean Buridan was a 14th-century French philosopher and logician, widely regarded for his contributions to the study of free will, determinism, and ethics. While his works span various domains of thought, one of his most well-known contributions is the famous `Buridan's Ass` paradox—a thought experiment that delves into the complexities of decision-making in the face of equal options. - -In this paradox, Buridan imagines a donkey caught between two equally enticing bales of hay. Unable to choose between them, the donkey, despite being hungry, ends up starving because of its inability to make a decision. This paradox is often used to highlight the difficulties we face when confronted with equally viable options, and the resulting inaction that can occur when there's no clear reason to choose one over the other. - -While Buridan's Ass symbolizes indecision, it also points to the importance of making choices even when they seem equally valid. Just like the donkey, developers, designers, and creators often face such dilemmas when making choices between different approaches or technologies. - -# Why Buridan? - -I chose the name 'Buridan UI' to evoke the spirit of thoughtful decision-making in design. Just as Buridan's donkey faced a dilemma between two equally appealing bales of hay, developers often grapple with choices in component design and user experience. This site aims to provide a clear path through those choices by offering beautifully crafted, reusable components that simplify the decision-making process. - -The goal is to help you avoid the proverbial 'indecision' by offering pre-made components that are visually appealing, functionally robust, and easy to integrate. The burden of choice should not overwhelm you—it should be an opportunity for creativity and ease of implementation. - -# Explore and Create - -Dive into our collection of components and see how they can elevate your projects. Whether you’re building a new app or enhancing an existing one, Buridan UI is here to help you navigate the vast landscape of design choices with ease.