docs icon indicating copy to clipboard operation
docs copied to clipboard

fix: improving style guide

Open CBID2 opened this issue 1 year ago â€ĸ 1 comments
trafficstars

Why:

Closes: #31686

What's being changed (if available, include any code snippets, screenshots, or gifs):

This PR adds examples of how not to write content in GitHub's documentation to their style guide.

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [x] For content changes, I have completed the self-review checklist.

CBID2 avatar Feb 29 '24 00:02 CBID2

Automatically generated comment â„šī¸

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
contributing/style-guide-and-content-model/style-guide.md fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar Feb 29 '24 00:02 github-actions[bot]

Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on!

nguyenalex836 avatar Feb 29 '24 16:02 nguyenalex836

Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on!

Thanks @nguyenalex836. You can give feedback too! :) I'm open to your thoughts

CBID2 avatar Feb 29 '24 16:02 CBID2

Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on!

Thanks @nguyenalex836. You can give feedback too! :) I'm open to your thoughts

That's very kind of you! 😊 This isn't my area of expertise, and Ethan will be the superior resource - but I appreciate the kind words! 💛

nguyenalex836 avatar Feb 29 '24 21:02 nguyenalex836

write and "Admin"

Hi @ethanpalm. I made the changes.

CBID2 avatar Mar 01 '24 03:03 CBID2

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Mar 01 '24 16:03 github-actions[bot]