Skip to content

docs(readme): add a root README for the org defaults - #11

Merged
lkirc merged 2 commits into
mainfrom
hygiene/711-first-screen
Oct 24, 2026
Merged

lkirc merged 2 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.

  • A short root README says what this repository holds: the organization profile and the default community files.
  • The README says what the AI agent instruction files at the root are for.

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.

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
Replace the old product name "DMF Platform" with "dmfdeploy platform" and point the plan link at its renamed file.

Refs dmfdeploy/dmfdeploy#711

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

@lkirc lkirc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes good spot on the 'dmfdeploy'

@lkirc
lkirc merged commit bd0c353 into main Oct 24, 2026
1 check passed
@lkirc
lkirc deleted the hygiene/711-first-screen branch October 24, 2026 09:27
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