Skip to content

docs: rewrite Desktops-header.md for the tier model#825

Merged
igorpecovnik merged 1 commit intomainfrom
update-desktops-header-md
Apr 11, 2026
Merged

docs: rewrite Desktops-header.md for the tier model#825
igorpecovnik merged 1 commit intomainfrom
update-desktops-header-md

Conversation

@igorpecovnik
Copy link
Copy Markdown
Member

Summary

Update the user-facing intro for the Desktop menu (tools/include/markdown/Desktops-header.md) to match the state of the desktop submodule after the tier system landed in #824, and consolidate the duplicated 'resource-intensive' warning that lived in seven per-DE headers into a single place.

Desktops-header.md

  • New Tiered installs section with a table of minimal/mid/full and rough sizes (~500 MB / ~1 GB / ~2.5 GB).
  • Documents the browser substitution rule (chromium on Debian, firefox-esr on Debian riscv64, epiphany-browser on Ubuntu) and explains why we don't ship Ubuntu's chromium/firefox snap-shim.
  • Rewritten How it works bullets:
    • mention the install manifest at /etc/armbian/desktop/<de>.{packages,tier} and the clean-uninstall guarantee (downgrade/remove only ever touches packages the desktop install added)
    • drop the Armbian Imager line — it's no longer auto-installed (opt-in via module_appimage install app=armbian-imager)
    • mention the packages_uninstall extras (apport, snap stubs)
  • New Switching tiers section explaining upgrade/downgrade from the menu without reinstalling.
  • Tightened Networking section ('notably GNOME' instead of 'desktop environments that require NetworkManager').
  • Supported desktops table extended with xmonad and enlightenment, both already status: supported in the YAML.
  • Single consolidated 'resource-intensive' warning admonition that replaces the seven copies that used to live in per-DE headers. The new warning also mentions the automatic apt-get clean on remove.

Per-DE *01-header.md

Stripped the same Desktop installation is resource-intensive warning from all seven per-DE install headers (XFCE01, CINM01, GNME01, KDEP01, KDEN01, MATE01, I3WM01). The wording was identical across files, so consolidating it into the parent header means future edits happen in one place.

Other admonitions in those files are kept:

  • I3WM01: keyboard shortcuts info block
  • KDEN01: KDE Neon vs KDE Plasma note

Both are DE-specific and belong on the per-DE page.

Test plan

  • Run tools/config-assemble.sh -p and check the rendered docs page for the desktop section
  • Confirm the per-DE install pages no longer carry the duplicated warning
  • Confirm the parent Desktop menu page now has the consolidated warning

Update the Desktop menu's user-facing intro to reflect the
state of the desktop submodule after the tier system landed,
and consolidate the per-DE 'Desktop installation is
resource-intensive' warning into a single place.

Desktops-header.md
------------------
- Add a Tiered installs section explaining minimal/mid/full
  with rough sizes (~500 MB / ~1 GB / ~2.5 GB).
- Document the browser substitution rule (chromium on Debian,
  firefox-esr on Debian riscv64, epiphany-browser on Ubuntu)
  and explain why we don't ship Ubuntu's chromium/firefox
  snap-shim.
- Rewrite the How-it-works bullets:
    * mention the install manifest at /etc/armbian/desktop/
      <de>.{packages,tier} and the clean-uninstall guarantee
    * drop the Armbian Imager line — it's no longer auto-
      installed (opt-in via module_appimage install instead)
    * mention the packages_uninstall extras (apport, snap stubs)
- Add a Switching tiers section explaining upgrade/downgrade
  from the menu without reinstalling.
- Tighten the Networking section ('notably GNOME' instead of
  'desktop environments that require NetworkManager').
- Extend the Supported desktops table with xmonad and
  enlightenment, both already status: supported in the YAML.
- Add a single 'resource-intensive' warning admonition that
  consolidates the seven copies that used to live in each
  per-DE header (XFCE01, CINM01, GNME01, KDEP01, KDEN01,
  MATE01, I3WM01). The new warning also mentions the
  automatic apt-get clean on remove.

Per-DE *01-header.md
--------------------
Strip the warning admonition from each of the seven per-DE
install headers. The same warning was duplicated verbatim in
each file; consolidating it into the parent Desktops-header.md
means edits to the wording only need to happen in one place.

Other admonitions in those files (i3-wm keyboard shortcuts,
KDE Neon vs KDE Plasma comparison) are kept untouched — they
are DE-specific and belong on the per-DE page.
@github-actions github-actions bot added size/medium PR with more then 50 and less then 250 lines Documentation Documentation changes or additions 05 Milestone: Second quarter release labels Apr 11, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 11, 2026

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR removes a redundant resource-intensive warning block from seven individual desktop environment header files (CINM01, GNME01, I3WM01, KDEN01, KDEP01, MATE01, XFCE01) and consolidates related information into a central Desktops-header.md file. The main Desktops-header.md file undergoes significant expansion, introducing a tiered installation model (Minimal/Mid/Full) with size estimates, tier-switching via desktop-menu options, persistent package tracking to differentiate desktop-managed versus manually-installed packages, updated browser selection logic based on distro and architecture, and refreshed networking and desktop support documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary change: a rewrite of Desktops-header.md to document the tier model introduced in #824.
Description check ✅ Passed The description comprehensively explains the motivation (align docs with tier system), the changes made to Desktops-header.md, the consolidation of duplicate warnings across seven per-DE headers, and includes a test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-desktops-header-md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@igorpecovnik igorpecovnik merged commit 53350ea into main Apr 11, 2026
94 of 98 checks passed
@igorpecovnik igorpecovnik deleted the update-desktops-header-md branch April 11, 2026 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

05 Milestone: Second quarter release Documentation Documentation changes or additions size/medium PR with more then 50 and less then 250 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant