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.

Sign up for GitHub

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

Jump to bottom

chore: CLI docs (remove chat, sidebar, nightly) #1628

Merged
merged 8 commits into from
Nov 5, 2024
Merged

chore: CLI docs (remove chat, sidebar, nightly) #1628

merged 8 commits into from
Nov 5, 2024

Conversation

gabrielle-ong
Copy link
Contributor

@gabrielle-ong gabrielle-ong commented Nov 4, 2024 •
edited
Loading

Describe Your Changes

Updates

  • update outputs for CLI commands eg cortex ps cortex pull
  • Update details for CLI commands
  • move docs/hub/... to capabilities/models/sources/...

Deprecate/remove:

  • removed repetitions
    • beta, nightly
  • deprecate cortex chat
  • deprecate options eg --presets --attached
  • replace links
    • cli/chat to cli/run
    • API reference

Separate PR:

  • Models & Engines index page

Fixes Issues

  • Closes #
  • Closes #

Self Checklist

  • Added relevant comments, esp in complex areas
  • Updated docs (for bug fixes / features)
  • Created issues for follow-up changes or refactoring needed

@gabrielle-ong gabrielle-ong changed the title Cleanup CLI docs (remove chat, sidebar, nightly) chore: CLI docs (remove chat, sidebar, nightly) Nov 4, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 5, 2024

Preview URL: https://86f2ab6a.cortex-docs.pages.dev

dan-menlo
dan-menlo approved these changes Nov 5, 2024
View reviewed changes
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

@gabrielle-ong gabrielle-ong merged commit 1becaff into dev Nov 5, 2024
1 check passed
@gabrielle-ong gabrielle-ong deleted the feat/cli-docs-cleanup branch November 5, 2024 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dan-menlo dan-menlo dan-menlo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gabrielle-ong @dan-menlo