Skip to content

docs: add themed applications documentation - #85

Closed
yukazakiri wants to merge 1 commit into
snowarch:mainfrom
yukazakiri:docs/add-themed-apps
Closed

docs: add themed applications documentation#85
yukazakiri wants to merge 1 commit into
snowarch:mainfrom
yukazakiri:docs/add-themed-apps

Conversation

@yukazakiri

Copy link
Copy Markdown
Contributor

Summary

Add documentation for themed applications including chromium, firefox, spicetify, vscode, zed, terminals, gtk-qt, sddm, cli-tools, and vencord. Also adds themed apps category in the docs sidebar.

Motivation

Users need documentation on how to theme various applications to match the iNiR desktop environment. This PR adds comprehensive guides for theming popular applications.

Testing

  1. Build the docs site locally
  2. Navigate to the new themed apps documentation pages
  3. Verify sidebar shows the new category
  4. Check all links work correctly

Checklist

  • Tested on Niri (or Hyprland if applicable)
  • Tested both ii and waffle families for UI changes
  • Tested material, aurora, and inir styles for ii changes
  • No hardcoded values (colors, fonts, durations use design tokens)
  • Config changes synced in Config.qml and defaults/config.json
  • Config access uses optional chaining: Config.options?.section?.option ?? default
  • IPC functions have explicit return types (: void, : string, etc.)
  • Shell restarted after changes: qs kill -c ii; qs -c ii
  • Logs checked for errors: qs log -c ii | tail -50
  • Lazy-loaded components tested (Settings, overlays)
  • No console errors or warnings

Related

Closes #
Fixes #

Add documentation for themed applications including chromium, firefox,
spicetify, vscode, zed, terminals, gtk-qt, sddm, cli-tools, and vencord.
Also adds themed apps category in the docs sidebar.
@snowarch

Copy link
Copy Markdown
Owner

Thanks for working on this. We actually already have a docs site in the repo (it was gitignored for a while to keep things tidy during development). Your work could be useful as a reference or starting point for improvements.

Right now the PR has merge conflicts with the current codebase, so it can't be merged as-is. If you're still interested, it'd be worth syncing with what we already have and seeing where the gaps are. Would love to see contributions on the documentation front — it's an area that always needs love.

@yukazakiri

Copy link
Copy Markdown
Contributor Author

actually this one still needs some improvements as it also needs some examples and some possible issues they can encounter with solutions,

and i might need to read the color pipeline again as it has lots of changes aside from the previous branches

@yukazakiri
yukazakiri marked this pull request as draft April 11, 2026 16:23

@snowarch snowarch left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The themed application documentation content is valuable, but this PR targets the old docs-site/ (Astro-based) which is no longer the active documentation system — the project now uses wiki/ with MkDocs.

Since this is a draft and conflicting, I'd recommend:

  • Close this PR
  • If you'd like to contribute the docs, rewrite them as MkDocs pages targeting the wiki/ directory
  • Drop the bun.lock and any Astro-specific files

The content about chromium, firefox, terminals, CLI tools, etc. would be great additions to the wiki. Happy to help with the structure if you want to take another pass.

@snowarch

Copy link
Copy Markdown
Owner

Closing — targets the old docs-site/ (Astro), project now uses wiki/ (MkDocs). Content is welcome as a new PR targeting wiki/. See review comment.

@snowarch snowarch closed this Apr 18, 2026
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.

2 participants