Improve documentation with Argo/GPT4o #565
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ossessive pronouns and verb agreement. 2. Fixed formatting issues, including consistent use of capitalization for terms like "GitLab Project" and "GitLab Group/SubGroup." 3. Improved clarity by rephrasing some sentences for better readability. 4. Added YAML syntax highlighting for code blocks to improve readability. 5. Ensured consistent use of terminology, such as "log in" instead of "login" when used as a verb.
…ency with the official branding. 2. Corrected capitalization: Changed "devops" to "DevOps" for consistency with standard terminology. 3. Improved formatting: Removed extra spaces before the link in the "GitLab-CI" section.
…esses" for subject-verb agreement. 2. Improved formatting: Removed unnecessary line break in the first bullet point for consistency.
… "Queue Name" section and added missing commas for clarity. 2. Improved clarity: Added "has" in "after the Notebook has started" for grammatical correctness. 3. Enhanced readability: Added backticks around `%pip` and `%conda` to indicate they are commands. 4. Corrected minor formatting issues: Ensured consistent use of punctuation and spacing throughout the document.
This was referenced Dec 8, 2024
felker
approved these changes
Jan 10, 2025
There was a problem hiding this comment.
some really good typo fixes and language improvements to the GitLab CI page, in particular. Lots of fiddling with newlines and whitespace, which can be kinda noisy.
the LLM is very opinionated on consistently removing hard wraps within a paragraph, probably because it makes it much more consistent and "source code-esque" throughout the repo, even though we havent really decided on a convention. See #330 and discussion in #317.
Thoughts @keceli? Maybe worth modifying the LLM prompt to minimize these changes? or should we continue to use it to make the line wrapping more uniform
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to earlier PRs, using Argo/GPT4o to improve the services documentation. See issue #563.