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

[MAINTENANCE] Various typographical error fixes and improvements in the English usage #322

Conversation

alexsherstinsky
Copy link
Collaborator

@alexsherstinsky alexsherstinsky commented Nov 29, 2023

Scope

  • This change proposes to fix some typos and improve the readability of the Ludwig documentation.
  • More similar pull requests are to come gradually.

Copy link
Contributor

@arnavgarg1 arnavgarg1 left a comment

Choose a reason for hiding this comment

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

LGTM! Although, I wonder if we should move contributing.md from main ludwig to ludwig docs, and then point to the ludwig docs contributing.md from the main ludwig repo. What do you think?

Copy link
Collaborator

@justinxzhao justinxzhao left a comment

Choose a reason for hiding this comment

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

Nice!

@alexsherstinsky
Copy link
Collaborator Author

LGTM! Although, I wonder if we should move contributing.md from main ludwig to ludwig docs, and then point to the ludwig docs contributing.md from the main ludwig repo. What do you think?

@arnavgarg1 Before I merge, let us discuss. I kept it in the code repository using the logic that contributing is closer to code than documentation. I am not sure which is the best way; what is the reason for your recommendation that it be kept in the documentation repository? Thanks.

@arnavgarg1
Copy link
Contributor

arnavgarg1 commented Nov 29, 2023

Btw, you will also need to edit mkdocs.yaml to remove the contributing guide from the website index (it'll make sense once you take a look at the file in the repo)!

@arnavgarg1
Copy link
Contributor

@alexsherstinsky got it! I think that's reasonable actually, we can leave it in the main Ludwig repo.

@alexsherstinsky
Copy link
Collaborator Author

Btw, you will also need to edit mkdocs.yaml to remove the contributing guide from the website index (it'll make sense once you take a look at the file in the repo)!

@arnavgarg1 I thought that I did that -- could you please double check to make sure I did not miss it? Thanks!

@arnavgarg1
Copy link
Contributor

Oh I see it now, sorry about that!

@alexsherstinsky
Copy link
Collaborator Author

Oh I see it now, sorry about that!

@arnavgarg1 Not at all -- really appreciate doing the rechecking. Is there a way to view the "staged" content of the pull request, before I merge? Something like Netlify perhaps? Thanks!

@alexsherstinsky alexsherstinsky merged commit ff0f3e8 into master Nov 30, 2023
2 checks passed
@alexsherstinsky alexsherstinsky deleted the bugfix/docs/alexsherstinsky/overall/fix_varios_typos-2023_11_24-1 branch November 30, 2023 15:40
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