Contribute to the Dart blog
Editorial approach
Preserve the author's voice, intent, and requested scope. First person, contractions, anecdotes, humor, enthusiasm, and future-facing announcements can all be appropriate. Don't rewrite them merely to match documentation conventions.
Apply proofread-markdown selectively for clarity,
accuracy, accessibility, links, code formatting, and sound structure.
Their documentation-specific preferences aren't blanket blog requirements:
semantic line breaks and an 80-character limit aren't required,
especially when importing or lightly editing an existing post.
Fix or flag substantive issues with source fidelity, technical accuracy, accessibility, metadata, or rendering. Treat preference-only rewrites as suggestions unless copyediting was requested.
Read relevant reference material
- For a new post, import, metadata or media change, structural edit, or full review, read Dart blog post format.
- For a Google Doc import, also read Import from Google Docs.
- To add or update an author or resolve an unknown author ID, read Manage blog authors.
A small prose-only correction might need no reference.
Consult src/data/authors/, comparable recent posts,
or implementation source when a convention is unclear.
Code and quality checks
- If changing or writing Dart samples, follow Effective Dart. Validate complete examples when practical and label intentional omissions or pseudocode clearly.
- Before calling a post ready,
search the changed content for unresolved markers and placeholders,
such as
TODO,TBD, or placeholder notes. Report intentional markers or blockers instead of silently removing them.
Validate proportionally
For a new post or a change to metadata or content, run the build and link-reference checks:
dart run dash_site build
dart run dash_site check-link-references
When layout, media, metadata, or content significantly changes, consider previewing the site locally:
dart run dash_site serve
For a prose-only edit that doesn't change links, direct inspection of the content can be enough.