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

chore(docs) Clarify uds.dev Usage in Quick Start Docs #578

Closed
barronstone opened this issue May 31, 2024 · 0 comments · Fixed by #902
Closed

chore(docs) Clarify uds.dev Usage in Quick Start Docs #578

barronstone opened this issue May 31, 2024 · 0 comments · Fixed by #902
Labels
tech-debt Not a feature, but still necessary
Milestone

Comments

@barronstone
Copy link
Collaborator

Describe what should be investigated or refactored

Problem: The bottom of the Quick Start docs page lists several uds.dev URLs to access the UI, API, and RAG Server. It is not clear to first-time readers that these are the URLs to access those tools on the local system hosting LeapfrogAI.

Solution: Add a short explanation to clarify that these URLs are for accessing the locally hosted LeapfrogAI deployment.

Links to any relevant code

Checking Deployment section of the Quick Start guide

Additional context

One of our mission heroes reached out to ask about this. He tried clicking on the URLs when exploring our docs, but since he wasn't running LeapfrogAI locally it didn't go anywhere. He looked up the domain and saw that it was registered, causing more confusion. It looks like we're directing people to a website that we're not maintaining.

@barronstone barronstone added the tech-debt Not a feature, but still necessary label May 31, 2024
@justinthelaw justinthelaw linked a pull request Aug 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech-debt Not a feature, but still necessary
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant