docs(agents): update technical writing guidance and skills to avoid using see when referring to things. - #13820
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the technical documentation style guides across several files to discourage the use of "see" or "see the" when introducing links or cross-references, recommending action-oriented alternatives like "refer to", "consult", or "visit" instead. Feedback was provided on formatting-and-structure.md to correct the placement of a comma in an example, ensuring it is placed inside the closing quotation mark in accordance with the style guide.
|
Staged preview of the updated docs.flutter.dev site (updated for commit 722736e): https://flutter-docs-prod--docs-pr13820-proofread-avoid-see-tmelt011.web.app |
|
Staged preview of the updated flutter.dev site (updated for commit 722736e): https://flutter-dev-230821--www-pr13820-proofread-avoid-see-q99diu1c.web.app |
sfshaza2
left a comment
sfshaza2
left a comment
There was a problem hiding this comment.
It makes ME happy! lgtm
…sing see when referring to things. (#13820) Updated guidance on using "see" to refer to things. ## Presubmit checklist - [ ] If you are unwilling, or unable, to sign the CLA, even for a _tiny_, one-word PR, please file an issue instead of a PR. - [ ] If this PR is not meant to land until a future stable release, mark it as draft with an explanation. - [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style)—for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person pronouns). - [ ] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer.
3 participants
Updated guidance on using "see" to refer to things.
Presubmit checklist
of 80 characters or fewer.