Skip to content

Docs/align readme template#16

Merged
willwade merged 3 commits into
mainfrom
docs/align-readme-template
Jun 28, 2026
Merged

Docs/align readme template#16
willwade merged 3 commits into
mainfrom
docs/align-readme-template

Conversation

@willwade

Copy link
Copy Markdown
Contributor

Summary

Issue / RFC: #

Type of change

  • Bug fix
  • New feature
  • Cross-platform / parity change
  • Refactor / tooling / docs

Cross-platform impact

A core goal of Dasher v6 is feature parity across frontends. Help reviewers
see the blast radius:

  • This changes a capability that users see on other platforms.
    If checked, I have opened / updated the feature matrix
    (website/src/data/feature-status.json) — linked PR: #
    (or confirmed this is genuinely platform-specific-only)
  • This introduces a new UX or hardware interaction.
    If checked, an RFC (governance/rfcs) is linked: #

Definition of Done

  • CI is green (build + tests + lint + format, as applicable)
  • Tests added for new behaviour
  • Feature matrix updated if this affects a cross-platform capability
  • Docs / changelog updated if the change is user-facing
  • Commits are signed off (DCO) — git commit -s

willwade added 3 commits June 29, 2026 00:46
- Opening matches template two-sentence intro
- Badges: CI, Release, License
- Status blockquote with feature matrix link
- Install section with releases link
- Build section: prerequisites + numbered steps that paste into terminal
- Architecture: one paragraph + mermaid diagram (replaces ASCII art)
- Command protocol table updated with opcode 6 (set line width)
- Repository layout as per template
- Contributing links to CONTRIBUTING.md + org guide
- License links to org LICENSE
- Removed stale 'Plan' section and 'Work in Progress' header

Signed-off-by: will wade <willwade@gmail.com>
Mermaid parser chokes on [] inside edge labels. Changed to 'int buffer'.

Signed-off-by: will wade <willwade@gmail.com>
v5 alphabet support request was implemented natively by DasherCore
team (PRs #31-33). Document is stale and no longer needed.

Signed-off-by: will wade <willwade@gmail.com>
@willwade willwade merged commit b52a923 into main Jun 28, 2026
2 checks passed
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