Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved GitHub Plans Documentation #35946

Closed
wants to merge 1 commit into from
Closed

Conversation

ayushsvtt
Copy link

@ayushsvtt ayushsvtt commented Jan 15, 2025

Hi Team,

I’ve made the following improvements to the GitHub plans documentation:

Replaced placeholders like {% data variables.product.prodname_dotcom %} with explicit terms for clarity. Simplified complex sentences to improve readability. Fixed broken links by replacing placeholders like [AUTOTITLE] with accurate URLs. Enhanced structure by organizing content with clear headers and bullet points. Removed redundant content to streamline the document. These changes ensure the documentation is easier to understand, more accurate, and user-friendly. Please review the changes, and let me know if further modifications are needed.

Thank you!

Why:

Closes:

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

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

Hi Team,

I’ve made the following improvements to the GitHub plans documentation:

Replaced placeholders like {% data variables.product.prodname_dotcom %} with explicit terms for clarity.
Simplified complex sentences to improve readability.
Fixed broken links by replacing placeholders like [AUTOTITLE] with accurate URLs.
Enhanced structure by organizing content with clear headers and bullet points.
Removed redundant content to streamline the document.
These changes ensure the documentation is easier to understand, more accurate, and user-friendly.
Please review the changes, and let me know if further modifications are needed.

Thank you!
Copy link

welcome bot commented Jan 15, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 15, 2025
Copy link
Contributor

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
get-started/learning-about-github/githubs-plans.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

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

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team and removed triage Do not begin working on this issue until triaged by the team labels Jan 15, 2025
@nguyenalex836
Copy link
Contributor

Hello @ayushsvtt 👋 Thank you for submitting a PR!

While we are grateful for the time you took to raise this PR, we are unable to accept this contribution as these updates do not necessarily provide improvements to the docs 🙇 A few examples:

Replaced placeholders like {% data variables.product.prodname_dotcom %} with explicit terms for clarity.

These are actually variables, which are short strings of reusable text 💛 You can read more about them here!

Fixed broken links by replacing placeholders like [AUTOTITLE] with accurate URLs.

AUTOTITLE text is actually used intentionally to format URLs, which you can read more about here in our style guide 💛

Please don't be discouraged! If you're looking for another issue pick up, take a look at our help wanted section to find open issues you can work on ✨ thank you again for your willingness to improve our docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants