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: linting, syntax, formatting & spelling fixes for all files #761

Merged
merged 11 commits into from
Jan 2, 2024

Conversation

oceaster
Copy link
Contributor

@oceaster oceaster commented Jan 2, 2024

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.

docs/api.md Outdated Show resolved Hide resolved
docs/autogen.md Outdated Show resolved Hide resolved
docs/embedding_endpoints.md Outdated Show resolved Hide resolved
docs/functions.md Outdated Show resolved Hide resolved
docs/local_llm_settings.md Outdated Show resolved Hide resolved
docs/ollama.md Show resolved Hide resolved
Copy link
Collaborator

@cpacker cpacker left a 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!

Copy link
Contributor Author

@oceaster oceaster left a comment

Choose a reason for hiding this comment

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

Solved all issues.

docs/api.md Outdated Show resolved Hide resolved
docs/embedding_endpoints.md Show resolved Hide resolved
docs/ollama.md Show resolved Hide resolved
Copy link
Contributor Author

@oceaster oceaster left a 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 oceaster requested a review from cpacker January 2, 2024 03:27
@oceaster oceaster closed this Jan 2, 2024
@oceaster oceaster deleted the documentation-fixes branch January 2, 2024 03:48
@oceaster oceaster restored the documentation-fixes branch January 2, 2024 03:48
@cpacker
Copy link
Collaborator

cpacker commented Jan 2, 2024

@oceaster do you want me to reopen this PR? Not sure if you closed it by mistake or not

@oceaster
Copy link
Contributor Author

oceaster commented Jan 2, 2024

@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.

@oceaster oceaster reopened this Jan 2, 2024
@oceaster oceaster changed the title fix: linting, syntax, formatting & spelling for all docs files docs: linting, syntax, formatting & spelling for all docs files Jan 2, 2024
@oceaster oceaster changed the title docs: linting, syntax, formatting & spelling for all docs files docs: linting, syntax, formatting & spelling fixes for all files Jan 2, 2024
docs/.markdownlint.json Show resolved Hide resolved
@cpacker cpacker self-requested a review January 2, 2024 18:31
@cpacker cpacker merged commit 1acb994 into letta-ai:main Jan 2, 2024
2 checks passed
norton120 pushed a commit to norton120/MemGPT that referenced this pull request Feb 15, 2024
…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]>
mattzh72 pushed a commit that referenced this pull request Oct 9, 2024
* 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]>
carenthomas pushed a commit that referenced this pull request Jan 24, 2025
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.

2 participants