Skip to content

docs(agents): update technical writing guidance and skills to avoid using see when referring to things. - #13820

Merged
lamek merged 1 commit into
flutter:mainfrom
lamek:proofread-avoid-see
Aug 27, 2026
Merged

docs(agents): update technical writing guidance and skills to avoid using see when referring to things.#13820
lamek merged 1 commit into
flutter:mainfrom
lamek:proofread-avoid-see

Conversation

@lamek

@lamek lamek commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

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—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
    of 80 characters or fewer.

@lamek
lamek requested review from a team and sfshaza2 as code owners August 26, 2026 22:20

@gemini-code-assist gemini-code-assist Bot 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.

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.

@flutter-website-bot

Copy link
Copy Markdown
Collaborator

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

@flutter-website-bot

Copy link
Copy Markdown
Collaborator

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 sfshaza2 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.

It makes ME happy! lgtm

@lamek
lamek merged commit babbb14 into flutter:main Aug 27, 2026
11 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.

3 participants