Compare commits

...

1 Commits

Author SHA1 Message Date
Nate Butler
0aa6bd4c7d Start on /build docs 2024-09-12 14:10:58 -04:00
3 changed files with 44 additions and 0 deletions

View File

@@ -128,3 +128,8 @@
- [Contributing to Zed](./contribute-to-zed.md)
- [Conversations](./conversations.md)
- [Feedback and Support](./feedback-and-support.md)
# Build
- [Index](./build/build.md)
- [Design](./build/design.md)

11
docs/src/build/build.md Normal file
View File

@@ -0,0 +1,11 @@
# Build
This documentation contains guidance and best practices that can help you design and build for great experiences in Zed.
## [Design](./design.md)
Design guidelines and best practices for buiding UI and designing features for Zed.
---
- `/dev` - Development guidelines, build tools, and best practices for writing production-ready code for Zed.

28
docs/src/build/design.md Normal file
View File

@@ -0,0 +1,28 @@
# Designing for Zed
Developers depend on their code editor to help them execute tasks, stay in flow, and write code every day.
As you start to think about designing features & improvements, first think deeply about why people use an editorwhy they use Zed as their editor. Always think about the developer's critical needs, then consider the characteristics and patterns expected in and editor, and the philosophies Zed employs when designing software:
**Complex, Simple**
- Simplicity or minimalisim for the sake of itself is a non-goal
- editors are power tools, zed's peers are spreadsheet/database tools, 3d or video editing software, etc.
- Find the most clear way to do something without sacrificing or obscuring complexity.
**Seemless, Flowing**
- People's input should register instantly
- Flows should not be blocked unless required
- Interruptions are the enemy of good code
**Empowered, Intelligent**
- Like a spreadsheet empowers an analyst to navigate and parse complex data, the editor should empower the workflows of developers to solve...
- Artificial Intelligence should...
- Bake in the tools needed for developers to achieve their goals
**Opinionated, Informed**
- Data-informed, never data-driven.
**Collaborative, (all in one place)**
- Every workflow should be collaborative.
- The editor is the place where work gets donesolo or in a group.
- Every time a person needs to leave the editor ask "Is this something I should be able to do right in my editor?"