Skip to content

docs: refine README and fix stale paths in the manual - #1

Merged
rubiin merged 1 commit into
mainfrom
docs/refine-readme
Oct 3, 2026
Merged

rubiin merged 1 commit into
mainfrom
docs/refine-readme

Conversation

@Delcado19

Copy link
Copy Markdown
Collaborator

Follow-up to the review note on HyDE-Project/HyDE#2129 that the README needs more refining.

README

  • What the window is and how it behaves (categories, global search, live Wallbash colours, missing tools stay visible).
  • Installation via the extra-dots deez flow, what gets deployed where, and the dependencies (python-gobject, gtk3, Python 3.11+).
  • Usage: hyde-shell settings, --system-info, --help.
  • Development: the local preview and both test commands, and why HyDE pins a tag instead of main.

Manual / test plan (leftovers from before the repo split)

  • sh Configs/.local/lib/hyde/settings.sh is now sh settings.sh.
  • "core dependencies in both installer lists" / "core dotfile manifest" now describe the dot's own dependency block and deployed files.
  • Scripts/dots/hyde.toml sync-path advice now points at applications/ plus HyDE's Scripts/dots/settings.toml.
  • tests/run.sh only exists in HyDE; standalone commands are listed first.
  • Broken hyde-settings-tests.md link now points to tests.md.

Docs only. python3 tests/settings_test.py passes locally (22 tests); the deploy command in the README was run against a scratch HOME and installed all five files.

The README gains installation, usage and dependency sections. The manual and test plan still described the pre-split layout (Configs/.local/lib/hyde paths, tests/run.sh, core installer lists, a broken test-plan link); they now match this repository.
@coderabbitai

coderabbitai Bot commented Sep 25, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: e8f72b98-fbcd-4c38-8bd5-b25d1a156bbd


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.

@rubiin
rubiin merged commit 3c909b1 into main Oct 3, 2026
2 checks passed
@rubiin
rubiin deleted the docs/refine-readme branch October 3, 2026 11:21
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