Migrate Omarchy Manual to a Markdown based Git Repo #4008
Closed
saif-raja
started this conversation in
Suggestions
Replies: 1 comment
-
|
I'd like to add Markdown exports to the Omarchy manual, but there are no plans to switch away from Writebook. The manual is so well updated because it's so easy for me to make those updates. That's worth more. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
The Omarchy manual is currently hosted on Writebook, which makes effectively unexportable. While the content itself is excellent, its current form limits how it can be used — especially in workflows that rely on modern, terminal-native AI tooling.
It would be enormously valuable if the Omarchy manual lived either inside the Omarchy OS repository itself, or in a neighboring repository within the same organization, with the content authored in Markdown.
This change would unlock several practical benefits :
- AI-native documentation workflows :
Tools like Claude Code, Gemini CLI, and other terminal-native agents work best when they can ingest local Markdown directly. If the manual were in a repo, users could clone it and give agents first-class access to the actual Omarchy documentation, rather than forcing them to reverse-engineer intent by scanning source code.
- Faster, more accurate configuration discovery :
Today, the alternative is to clone the Omarchy repo and ask agents to go on discovery runs to reconstruct context that already exists—clearly and intentionally—inside the manual. This is redundant and error-prone. Markdown docs would let agents reason directly from the same distilled knowledge humans use.
- Alignment with Omarchy’s principles :
Terminal-native tools, composability, local-first workflows, and user agency are deeply aligned with Omarchy’s ethos. Making the documentation accessible in a plain-text, version-controlled format fits naturally with that philosophy.
- No lossy HTML to Markdown conversions :
Right now, anyone who wants to use the manual with AI tooling has to manually convert HTML to Markdown, which is unreliable and strips structure. A canonical Markdown source avoids this entirely.
At a higher level, this would make the knowledge currently concentrated in @dhh ’s head — and expressed so clearly in the manual — programmatically accessible to everyone. Not just readable, but operationalizable by tools that help users explore, configure, and understand Omarchy more deeply and with agility.
I think this would meaningfully improve the onboarding and configuration experience for advanced users, while staying true to what Omarchy is about.
Beta Was this translation helpful? Give feedback.
All reactions