mirror of
https://github.com/fleetdm/fleet
synced 2026-05-06 06:48:54 +00:00
77972a5fa2
Closes https://github.com/fleetdm/fleet/issues/18969 @Sampfluger88, here's the PR you secretly wanted, but I'm sorry to throw the review in your lap! I planned to add clear guidance on writing types (guides vs. articles vs. website copy), but I couldn't comfortably do that because the entire Writing section needed attention before that could fit in properly. I reorganized the section to make it easier to follow and maintain, grouping existing content into clearer buckets: - Style & values - Types (examples of different writing formats at Fleet; can expand later to include social media) - Process (editing, publishing, PR review) - Inspiration (Mister Rogers / Paul Graham) - Assistance (tools like Grammarly and generative AI) - Mechanics (rules across all mediums) - Markdown (website-specific rules) These now live under the following headings: - Writing (top-level intro) - Writing style - Writing types - Editing and publishing - Further inspiration (Mister Rogers) - Writing assistance (Grammarly and generative AI) - Writing mechanics (Fleet-specific conventions across all writing) - Writing in Fleet-flavored Markdown (rules specific to the website) The old structure mixed values, style, rules, and process, which made it hard to scan. This new hierarchy separates high-level principles from detailed rules and tool guidance, so contributors can find what they need more quickly. ### Next steps I plan to circle back to optimize the Mechanics section: - Trim redundant content - Make examples consistent in style - Improve the order of rules ✊ --------- Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| ceo | ||
| company | ||
| customer-success | ||
| engineering | ||
| finance | ||
| it-and-enablement | ||
| marketing | ||
| people | ||
| product-design | ||
| sales | ||
| README.md | ||
Welcome to Fleet
Introduction
The Fleet handbook is the living source of truth for how we run the company. This handbook is open to the world and feedback and contributions are welcome from everyone. Feel free to click "Edit this page" to suggest an improvement anywhere you see fit. (The right reviewer will be automatically notified, and will reply to you promptly. Your change will go live on the website ≈10 minutes after it is merged.)