morgankrey
f3f80e36de
## Summary This PR establishes the foundation for documentation quality and automation. ## Documentation Conventions (`docs/.conventions/`) **CONVENTIONS.md** - Structural guidelines covering: - What needs documentation vs what to skip - Page vs section decisions (with examples) - Document structure and section ordering - Formatting conventions (code, JSON, tables, callouts) - Anchor ID patterns for stable deep-linking - Settings documentation pattern (UI first, then JSON) - Terminology standards (aligned with docs/AGENTS.md) - Prettier formatting requirements **brand-voice/** - Zed's writing style: - `SKILL.md` - Core voice principles - `rubric.md` - 8-point scoring criteria (must score 4+ on all) - `taboo-phrases.md` - Patterns to avoid (exclamation points, hype words) - `voice-examples.md` - Before/after transformations ## Gold Standard Examples (`docs/.doc-examples/`) Four templates demonstrating best practices: - `simple-feature.md` - Overview/navigation docs - `complex-feature.md` - Comprehensive feature docs - `configuration.md` - Settings documentation - `reference.md` - API/tool reference ## Related Follow-up PR #49177 applies these conventions to existing documentation. Release Notes: - N/A
Zed
Welcome to Zed, a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Installation
On macOS, Linux, and Windows you can download Zed directly or install Zed via your local package manager (macOS/Linux/Windows).
Other platforms are not yet available:
- Web (tracking issue)
Developing Zed
Contributing
See CONTRIBUTING.md for ways you can contribute to Zed.
Also... we're hiring! Check out our jobs page for open roles.
Licensing
License information for third party dependencies must be correctly provided for CI to pass.
We use cargo-about to automatically comply with open source licenses. If CI is failing, check the following:
- Is it showing a
no license specifiederror for a crate you've created? If so, addpublish = falseunder[package]in your crate's Cargo.toml. - Is the error
failed to satisfy license requirementsfor a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to theacceptedarray inscript/licenses/zed-licenses.toml. - Is
cargo-aboutunable to find the license for a dependency? If so, add a clarification field at the end ofscript/licenses/zed-licenses.toml, as specified in the cargo-about book.
Sponsorship
Zed is developed by Zed Industries, Inc., a for-profit company.
If you’d like to financially support the project, you can do so via GitHub Sponsors. Sponsorships go directly to Zed Industries and are used as general company revenue. There are no perks or entitlements associated with sponsorship.