-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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: linting, syntax, formatting & spelling fixes for all files #761
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! Left a few comments on things I think may need revising, otherwise looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Solved all issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, forgot to mark this as resolved.
@oceaster do you want me to reopen this PR? Not sure if you closed it by mistake or not |
@cpacker Oh, absolutely no idea how this was closed. Thanks for noticing, yes please re-open. I merged everything into main on my fork, and deleted this branch, that's why face_palm, gave you edit permissions - if you didn't have them already. |
…ta-ai#761) * Update README.md * fix: 'ollama run' should be 'ollama pull' * fix: linting, syntax, spelling corrections for all docs * fix: markdown linting rules and missed fixes * fix: readded space to block * fix: changed sh blocks to text * docs: added exception for bare urls in markdown * docs: added exception for in-line html (MD033/no-inline-html) * docs: made python indentation level consistent (4 space tabs) even though I prefer 2. --------- Co-authored-by: Charles Packer <[email protected]>
* Update README.md * fix: 'ollama run' should be 'ollama pull' * fix: linting, syntax, spelling corrections for all docs * fix: markdown linting rules and missed fixes * fix: readded space to block * fix: changed sh blocks to text * docs: added exception for bare urls in markdown * docs: added exception for in-line html (MD033/no-inline-html) * docs: made python indentation level consistent (4 space tabs) even though I prefer 2. --------- Co-authored-by: Charles Packer <[email protected]>
Please describe the purpose of this pull request.
I have fixed all the docs files to be standardised, spell corrected, formatted appropriately and should not cause any red flags on ci/cd pipelines anyone might have when forking this repository.
How to test
Review the commit log, Preview the files on github, Documentation fixes only.
Have you tested this PR?
Yes.
Related issues or PRs
#760
Additional context
I had issues with the .md files not being formatted properly and it was causing issues with my ci/cd pipeline. Makes sense to merge this back into the mainstream repo.