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 improvements #1891

Merged
merged 23 commits into from
Jan 31, 2025
Merged

Docs improvements #1891

merged 23 commits into from
Jan 31, 2025

Conversation

ramonpzg
Copy link
Contributor

@ramonpzg ramonpzg commented Jan 27, 2025

General Documentation Improvements

General Improvements

  • fixed typos and misspellings
  • normalized saying Cortex in favor of Cortex.cpp
  • simplified the repo's main README
  • added images where possible to illustrate the topic being discussed in a section, for example, to show the way in which cortexso hub saves model versions in different git branches, or how to query the various tables in our cortex.db sqlite file
  • Pedantic changes:
    • favor use and using instead of utilizing
    • The AI space is moving so fast that it is best to rephrase "industry standard" to "sensible defaults" or something similar
    • Removed words such as simple, super easy, and extremely easy.
  • Broke long lines into smaller ones
  • Separated code block where the command and the output were on the same line. This makes it easier for readers to copy the command they want to use without the response they don't need.
  • Remove > from in front of many shell commands across the docs. This adds friction between users copying the command with one click and having to move to the beginning of the line to delete the greater than sign >.
  • remove TensorRT-LLM from the docs
  • improved python engine explanation
  • Removed warning where appropriate

Noticeable changes

  • Simplified explanations, where possible
  • Created a Guide for text generation
  • Re-created the structured outputs section

@ramonpzg ramonpzg requested a review from dan-menlo January 27, 2025 06:10
@ramonpzg ramonpzg self-assigned this Jan 27, 2025
Copy link
Contributor

github-actions bot commented Jan 28, 2025

Preview URL: https://d843113b.cortex-docs.pages.dev

@ramonpzg ramonpzg changed the title Doc improvs Docs improvements Jan 28, 2025
@ramonpzg ramonpzg added the type: docs Improvements or additions to documentation label Jan 28, 2025
Copy link
Contributor

@dan-menlo dan-menlo left a comment

Choose a reason for hiding this comment

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

Lgtm

@ramonpzg ramonpzg merged commit ebc0d34 into dev Jan 31, 2025
1 check passed
@ramonpzg ramonpzg deleted the doc-improvs branch January 31, 2025 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants