Skip to content

docs: rename Docs, improve first edit, and stabilize validation - #5

Merged
KitsuneSemCalda merged 4 commits into
masterfrom
docs/readme-and-directory
Oct 18, 2026
Merged

KitsuneSemCalda merged 4 commits into
masterfrom
docs/readme-and-directory

Conversation

@KitsuneSemCalda

@KitsuneSemCalda KitsuneSemCalda commented Oct 18, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Rename Docs/ to docs/ and update repository links, source comments, and the release notes lookup.
  • Rewrite the README around the first edit, bundled demo, installation, validated RC scope, and feedback route.
  • Move the optional Hyprland opacity rule to a short dedicated page.
  • Make the GUI smoke wait for audio waveform analysis before exercising noise reduction and normalization. The previous master run failed because analysis was still pending.
  • Measure sustained RSS after the documented Mesa warm-up with three-cycle medians; keep the early per-cycle file-descriptor invariant. The prior Clang Debug run failed on a transient fourth-cycle RSS rise.

Verification

  • git diff --check
  • scripts/changelog.sh v0.1.0-rc.1 reads the reviewed release notes from docs/releases/.
  • Local links in README, CONTRIBUTING, and CLAUDE resolve.
  • The existing editor screenshot was inspected and remains a genuine GUI smoke capture.
  • The changed GUI smoke source compiled locally; CI will exercise the full headless run.
  • The sustained workload case passed locally for 16 cycles with a constant five file descriptors; the early and late post-warm RSS medians were 370 and 364 MiB.

@KitsuneSemCalda KitsuneSemCalda changed the title docs: rename Docs and clarify first edit docs: rename Docs, improve first edit, and stabilize validation Oct 18, 2026
@KitsuneSemCalda
KitsuneSemCalda merged commit 4261266 into master Oct 18, 2026
22 checks passed
@KitsuneSemCalda
KitsuneSemCalda deleted the docs/readme-and-directory branch October 18, 2026 13:22
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