Skip to content

Rewrite the README for contributors - #16

Merged
itz4blitz merged 1 commit into
mainfrom
docs/readme
Oct 17, 2026
Merged

itz4blitz merged 1 commit into
mainfrom
docs/readme

Conversation

@itz4blitz

Copy link
Copy Markdown
Owner

Summary

  • Rewrites the README around what main ships today: six networks, packages, the updater, shortcuts, systemd, animated images, Note to Self, and tinyclient --text --search.
  • Adds a contents list, a repository map, feature flags, and the review rule, so a new contributor can find the spec and the build without reading the whole tree.
  • Records work still open: sidebar cache (fix: restore cached network sidebars immediately #10, conflicting) and Discord voice channels, the call click, and camera or screen share.

Test plan

Made with Cursor

…s in flight.

Co-authored-by: Cursor <cursoragent@cursor.com>
@itz4blitz
itz4blitz merged commit 7ac7c74 into main Oct 17, 2026
6 checks passed
@itz4blitz
itz4blitz deleted the docs/readme branch October 17, 2026 15:03
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