Skip to content

Redesign the public README and documentation - #28

Merged
Nickfost merged 34 commits into
mainfrom
docs/record-delivery-fleet-decisions
Jul 15, 2026
Merged

Redesign the public README and documentation#28
Nickfost merged 34 commits into
mainfrom
docs/record-delivery-fleet-decisions

Conversation

@Nickfost

@Nickfost Nickfost commented Jul 14, 2026

Copy link
Copy Markdown
Member

Summary

Turns repository Markdown into a clear public documentation system:

  • redesigns the root README as a GitHub landing page for new users;
  • explains the problem, intended audience, architecture, trust model, project contract, status, and roadmap;
  • adds visual architecture and growth diagrams;
  • adds search-friendly terminology for self-hosted runners, Docker CI, Proxmox, test sharding, and distributed workers;
  • adds a task-oriented documentation index and glossary;
  • replaces the opaque docs/adr presentation with plain-language controller and configuration guides;
  • documents how a public source repository can use private fleet CI and deployment through a protected private delivery repository;
  • links operators directly to host, project, migration, security, maintenance, and pilot procedures.

This PR changes documentation only. It does not rename the repository or live installation, modify the pilot controller, or claim that setup.sh is already implemented.

Closes #26
Relates to #21, #24, and #27.

@Nickfost Nickfost changed the title Record documentation, naming, and setup decisions Redesign the public README and record project decisions Jul 15, 2026
@Nickfost Nickfost changed the title Redesign the public README and record project decisions Redesign the public README and add a documentation index Jul 15, 2026
@Nickfost Nickfost changed the title Redesign the public README and add a documentation index Redesign the public README and documentation Jul 15, 2026

@Nickfost Nickfost left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

aok

@Nickfost
Nickfost merged commit c5a6bd4 into main Jul 15, 2026
1 check passed
@Nickfost
Nickfost deleted the docs/record-delivery-fleet-decisions branch July 24, 2026 03:51
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.

Make repository Markdown the canonical documentation source

1 participant