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

docs,ui: low vram guide & first run blurb #7533

Merged
merged 9 commits into from
Jan 9, 2025
Merged

docs,ui: low vram guide & first run blurb #7533

merged 9 commits into from
Jan 9, 2025

Conversation

psychedelicious
Copy link
Collaborator

Summary

  • Fix minor issue in the configuration docs.
  • Add docs for low-VRAM mode, with links to the new page in the Features and Configuration sections.
  • Update the first run screen to include a link to the docs:

image

QA Instructions

Build the docs locally to preview.

Checklist

  • The PR has a short but descriptive title, suitable for a changelog
  • Documentation added / updated (if applicable)

@github-actions github-actions bot added Root frontend PRs that change frontend files docs PRs that change docs labels Jan 8, 2025
RyanJDick
RyanJDick approved these changes Jan 8, 2025
View reviewed changes
Copy link
Collaborator

@RyanJDick RyanJDick left a comment

Choose a reason for hiding this comment

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

Excellent docs. I just suggested one nit-pick.

docs/features/low-vram.md Outdated Show resolved Hide resolved
@psychedelicious
Copy link
Collaborator Author

psychedelicious commented Jan 8, 2025 •
edited
Loading

Updated first run page (Low VRAM callout only rendered on Local):
image

OOM toast (local only):
image

(the minor vertical alignment issue w/ the links is fixed, just didn't capture it in screenshots)

@psychedelicious psychedelicious enabled auto-merge (rebase) January 9, 2025 00:17
@psychedelicious psychedelicious merged commit a329588 into main Jan 9, 2025
15 checks passed
@psychedelicious psychedelicious deleted the psyche/docs/low-vram branch January 9, 2025 00:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hipsterusername hipsterusername hipsterusername approved these changes

@RyanJDick RyanJDick RyanJDick approved these changes

@blessedcoolant blessedcoolant Awaiting requested review from blessedcoolant blessedcoolant is a code owner

@maryhipp maryhipp Awaiting requested review from maryhipp maryhipp is a code owner

@lstein lstein Awaiting requested review from lstein lstein is a code owner

Assignees
No one assigned
Labels
docs PRs that change docs frontend PRs that change frontend files Root
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@psychedelicious @RyanJDick @hipsterusername