Skip to content

docs(readme): give the first screen a status header - #47

Merged
github-actions[bot] merged 5 commits into
mainfrom
hygiene/711-first-screen
Oct 23, 2026
Merged

github-actions[bot] merged 5 commits into
mainfrom
hygiene/711-first-screen

Conversation

@znerol2

@znerol2 znerol2 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

What & why

An outside reader clicking through the dmfdeploy repositories sees each README first. This change makes that first screen accurate and consistent with the other repositories.

  • The README opens with a short header: what the repository is, that it's part of the dmfdeploy open prototype, its status, and a link to the umbrella.
  • The read-first install comes before the piped one.
  • The supported Debian version matches dmf-infra.
  • The README says what the AI agent instruction files at the root are for.
  • CONTRIBUTING.md drops a note about a private archive mirror that doesn't apply to outside contributors.

Refs dmfdeploy/dmfdeploy#711

How it's tested

  • Every relative link in the changed Markdown files resolves in the tree.
  • The changed README has no error-level voice alerts.
  • A grep of the added lines finds no local paths, private hostnames or people's names.

Add the shared status header, drop pointers to files outsiders cannot
see, and remove the archive-mirror note from CONTRIBUTING.md.

Refs dmfdeploy/dmfdeploy#711

Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
@znerol2
znerol2 requested a review from a team as a code owner October 23, 2026 10:33
@github-actions
github-actions Bot enabled auto-merge (rebase) October 23, 2026 10:33
Rename the old product name to dmfdeploy platform, and state the tested Debian 13 and 16 GB RAM, 60 GB disk single-node figures.

Refs dmfdeploy/dmfdeploy#711

Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
@znerol2 znerol2 added the hold Disarm auto-merge: PR will not land on approval while this label is set label Oct 23, 2026
@github-actions
github-actions Bot disabled auto-merge October 23, 2026 10:40
Refs dmfdeploy/dmfdeploy#711

Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>

@lkirc lkirc left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Request changes: the target-node guidance contradicts the dmf-infra documentation it cites.

  • README.md:176-180 says dmf-infra documents Debian 13 plus a 4 vCPU / 16 GB / 60 GB minimum. Its current README documents Debian 12 and 3 nodes with 4+ CPU, 8+ GB RAM, and 80+ GB disk; related dmf-infra#101 likewise says Debian 12 is the documented target. Please correct this attribution and the requirements.

Describe the running v0.1 sandbox node instead of attributing the
requirements to another repository's README.

Refs dmfdeploy/dmfdeploy#711

Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
Refs dmfdeploy/dmfdeploy#713

Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
@znerol2

znerol2 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor Author

Fixed in 0299c64: the target-node section now describes the running v0.1 sandbox node directly (Debian 13, 4 vCPU ARM64, 16 GB RAM, 60 GB disk, about 7 GB RAM and 30 GB disk used at idle) and no longer attributes those figures to the dmf-infra README. dmfdeploy/dmf-infra#101 states the same facts.

Also in this push: 43ceddc removes a doubled word, and a4d9cc3 pins the one link to the umbrella session notes to a fixed commit, because dmfdeploy/dmfdeploy#713 removes that folder from the tree.

@znerol2
znerol2 requested a review from lkirc October 23, 2026 13:20
@znerol2 znerol2 removed the hold Disarm auto-merge: PR will not land on approval while this label is set label Oct 23, 2026
@github-actions
github-actions Bot enabled auto-merge (rebase) October 23, 2026 13:20

@lkirc lkirc left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved current head a4d9cc3. The earlier target-node concern is resolved: README.md now identifies the v0.1 sandbox profile as its own and separately states dmf-infra's Debian 12 baseline.

@github-actions
github-actions Bot merged commit a0ec7bf into main Oct 23, 2026
11 checks passed
@znerol2
znerol2 deleted the hygiene/711-first-screen branch October 23, 2026 14:36
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