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

docs on compiling: friendlier to first-time contributors #72166

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

Brambor
Copy link
Contributor

@Brambor Brambor commented Mar 4, 2024

Summary

None

Purpose of change

While helping a first-time contributor making PR #72153, some issues in docs became apparent. Not mentioning git led the poor soul to think there is no more to be done with git than to git clone so they got stuck at git push. It turned out, they didn't even make a fork.

I also saw some inconsistencies and things I thought could be improved (after my changes, it is subjectively better).

Describe the solution

Directly regarding the conversation with the first-time contributor

  • Link to git usage (example git workflow) from any compiling tutorial where appropriate.
  • Mention that fork != branch.

Furthermore

  • Some text made clickable.
  • remove a duplicate sentence
  • remove trailing whitespaces
  • Sometimes remove the Note: marker as I feel it is the core of the text.
  • etc.

Describe alternatives you've considered

Also, look for mentions that CDDA with history is 3GB. Replace them with the fact it is 6GB today.

Testing

Compiled the .MD file locally into HTML and click the links.

Additional context

@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs astyled astyled PR, label is assigned by github actions json-styled JSON lint passed, label assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions labels Mar 4, 2024
@Maleclypse Maleclypse merged commit 23efc74 into CleverRaven:master Mar 5, 2024
15 of 20 checks passed
@Brambor Brambor deleted the friendly-docs branch March 6, 2024 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions <Documentation> Design documents, internal info, guides and help. json-styled JSON lint passed, label assigned by github actions [Markdown] Markdown issues and PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants