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

[llvm][Docs] Update MyFirstTypoFix doc #79149

Merged
merged 3 commits into from
Jan 29, 2024

Conversation

DavidSpickett
Copy link
Collaborator

I've not tried to change the purpose or style of the doc, just edited for clarity and removed any Phabricator related language in favour of GitHub terms.

Where possible, I've swapped direct links to LLVM's website with RST links to the local documents. Which should be a bit more resilient.

Also it's less confusing if you're editing multiple pages locally, you don't accidentally end up on the live site.

@DavidSpickett
Copy link
Collaborator Author

DavidSpickett commented Jan 23, 2024

Inspired by #78292 where I'm considering whether to write some docs about what happens post merge, and the first step of that is to make sure what we have now is up to date.

@RalfJung feel free to review also if you wish to.

Copy link
Contributor

@asb asb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with one minor nit. Thanks for taking this on David!

llvm/docs/MyFirstTypoFix.rst Outdated Show resolved Hide resolved
I've not tried to change the purpose or style of the doc,
just edited for clarity and removed any Phabricator related
language in favour of GitHub terms.

Where possible, I've swapped direct links to LLVM's website
with RST links to the local documents. Which should be
a bit more resilient.

Also it's less confusing if you're editing multiple pages
locally, you don't accidentally end up on the live site.
@DavidSpickett DavidSpickett merged commit ba5d92e into llvm:main Jan 29, 2024
4 of 5 checks passed
@DavidSpickett DavidSpickett deleted the first-contrib-doc branch January 29, 2024 10:34
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.

None yet

2 participants