Skip to content

Add proofread_markdown skill and Dart wrapper script#13258

Merged
antfitch merged 4 commits intoflutter:mainfrom
antfitch:add_proofreading_skill
Apr 24, 2026
Merged

Add proofread_markdown skill and Dart wrapper script#13258
antfitch merged 4 commits intoflutter:mainfrom
antfitch:add_proofreading_skill

Conversation

@antfitch
Copy link
Copy Markdown
Contributor

@antfitch antfitch commented Apr 7, 2026

Proofread markdown skill for the Flutter Docs repo. You can use this skill to update your markdown files to follow the Flutter doc teams formatting guidelines.

  • Changes title case to sentence case in headings.
  • Converts headings from passive case to active case (note: when working with how-to and tutorials, this is a good thing, but there are times when this should be avoided, such as when you're introducing concepts. Look carefully at the changes before accepting them.
  • Ensures there is a blank line between heading and body text.
  • Refactors steps for brevity.

This is an early version of this skill. As time goes on, we'll update it to be more complete, fix bugs, etc. Use this with your AI agents, but in a mode where you can approve the changes.

@antfitch antfitch requested review from a team and sfshaza2 as code owners April 7, 2026 23:06
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new markdown proofreading skill and a supporting Dart script for automated line wrapping. The review feedback identifies a hardcoded absolute path in the documentation that needs to be corrected to a relative path. Additionally, the line-wrapping script has limitations in detecting ordered lists beyond three items and contains logic errors in the wrapText function that cause indentation loss and inaccurate width calculations.

Comment thread .agents/skills/proofread_markdown/SKILL.md Outdated
Comment thread .agents/skills/proofread_markdown/scripts/wrap_lines.dart Outdated
Comment thread .agents/skills/proofread_markdown/scripts/wrap_lines.dart
@flutter-website-bot
Copy link
Copy Markdown
Collaborator

flutter-website-bot commented Apr 7, 2026

Visit the preview URL for this PR (updated for commit 6f3d0fb):

https://flutter-docs-prod--pr13258-add-proofreading-skill-k2seal0i.web.app

@antfitch antfitch self-assigned this Apr 7, 2026
Copy link
Copy Markdown
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

See comments.

Comment thread .agents/skills/proofread_markdown/SKILL.md Outdated
Comment thread .agents/skills/proofread_markdown/scripts/wrap_lines.dart
Comment thread .agents/skills/proofread_markdown/SKILL.md Outdated
Comment thread .agents/skills/proofread_markdown/SKILL.md Outdated
Comment thread .agents/skills/proofread_markdown/SKILL.md Outdated
Comment thread .agents/skills/proofread_markdown/SKILL.md Outdated
@antfitch
Copy link
Copy Markdown
Contributor Author

antfitch commented Apr 8, 2026

@parlough
Copy link
Copy Markdown
Member

parlough commented Apr 8, 2026

Add the format that @parlough is using here to separate sections: https://github.com/flutter/website-cms/blob/main/.agents/skills/generate-showcase-from-video/SKILL.md

Just clarifying: That new, fancy skill is by @abdallahshaban557 :)

@antfitch antfitch force-pushed the add_proofreading_skill branch from 7f88129 to 8d727f8 Compare April 10, 2026 03:09
@antfitch antfitch force-pushed the add_proofreading_skill branch from 8d727f8 to 6f3d0fb Compare April 23, 2026 19:19
Copy link
Copy Markdown
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

I can live with this! :D. lgtm

Copy link
Copy Markdown
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

Oops! Forgot to click approve.

@antfitch
Copy link
Copy Markdown
Contributor Author

I can live with this! :D. lgtm

YAY! I had forgotten for a moment that of course we could have a semantic line break script. Just took a few days. @conooi you could update the dart skill with this, too. Should save lots of tokens.

@antfitch antfitch merged commit 9407123 into flutter:main Apr 24, 2026
10 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.

4 participants