Skip to content

docs: group the bar plugins under docs/plugin and add the Hyprsimple page - #47

Merged
rizukirr merged 1 commit into
mainfrom
docs/plugin-section
Oct 17, 2026
Merged

rizukirr merged 1 commit into
mainfrom
docs/plugin-section

Conversation

@rizukirr

@rizukirr rizukirr commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

Summary

Group the bar plugins under a docs/plugin/ section and add a page for the new muslimtify-hyprsimple plugin.

What Changes?

docs/plugin/
  _category_.json     "Plugins" category with a generated index page
  omarchy.md          moved from docs/omarchy-plugin.md, relative links fixed
  hyprsimple.md       new
  • The Hyprsimple page mirrors the Omarchy page's structure: requirements, install, key binding, manage, using it (bar, today, settings, keys), troubleshooting. Every statement was checked against the plugin's QML and lib/Model.js and against the hyprsimple-plugin manager script, not only the README: the owner/repository install shorthand, the install and enable lifecycle (daemon install then daemon status, left disabled on failure), the prayer panel alias, the keys, the 15 minute highlight, the settings sections in the order the view draws them, and the exact refusing dirty plugin update message.
  • command.md and the Get Started "Next steps" now link to the section.
  • The sidebar is autogenerated from the folder, so sidebars.ts is untouched.

Before merging: the old URL /docs/omarchy-plugin is live today and will 404 after this merges, because the page becomes /docs/plugin/omarchy. A redirect needs a maintainer change outside this PR, either @docusaurus/plugin-client-redirects in docusaurus.config.ts with {from: '/docs/omarchy-plugin', to: '/docs/plugin/omarchy'}, or a vercel.json redirect. The muslimtify-omarchy README likely links to the old URL.

Also noticed, outside this repository: lib/Model.js in muslimtify-hyprsimple links to https://muslimtify.vercel.app rather than muslimtify.org.

Type

  • Blog post (new or edited) — blog/
  • Documentation — docs/

Checklist

  • This PR only touches blog/ and/or docs/ (plus blog/authors.yml / blog/tags.yml if adding a post).
  • npm run build passes locally (catches broken links — the site uses onBrokenLinks: 'throw').
  • Every command I documented has been tested against the real Muslimtify CLI. (The muslimtify commands on the page are daemon status, daemon install and daemon uninstall, checked against v0.4.4. The hyprsimple-plugin commands were checked against the manager script's usage and source, not run on a live Hyprsimple session.)
  • Images are embedded via GitHub asset URLs (not committed into static/). (The video is the GitHub asset from the plugin's README.)

AI disclosure

Written with Claude Code (Claude Fable 5.1) by the maintainer. The model read the plugin and manager source and drafted the page and the move; the Omarchy page content is unchanged apart from its location, title and relative links.

@vercel

vercel Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
muslimtify Ready Ready Preview Oct 17, 2026 2:23pm UTC

…page

Move the Omarchy page to docs/plugin/omarchy.md under a Plugins category
with a generated index, and add docs/plugin/hyprsimple.md for the
muslimtify-hyprsimple plugin: install through hyprsimple-plugin, the
prayer panel alias and key binding, lifecycle commands, what the panel
and settings show, and the failure messages. Link the section from the
command reference and Get Started.
@rizukirr
rizukirr force-pushed the docs/plugin-section branch from d1ec3ac to ff2d94f Compare October 17, 2026 14:22
@rizukirr
rizukirr merged commit cee7174 into main Oct 17, 2026
3 checks passed
@rizukirr
rizukirr deleted the docs/plugin-section branch October 17, 2026 14:27

This branch was successfully deployed

1 active deployment
Preview — ff2d94f4 Deployed Oct 17, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant