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: Clarify Docker instructions #22

Open
MichaelCurrin opened this issue Aug 29, 2024 · 1 comment
Open

Docs: Clarify Docker instructions #22

MichaelCurrin opened this issue Aug 29, 2024 · 1 comment

Comments

@MichaelCurrin
Copy link

Hi, as someone new to the project I found the instructions confusing in README

I think the Features section is more important for a newcomer than Docker deploy, so Features should appear above it.

And the Docker deploy section could be moved to a Development heading next to Contributing, or even a docs/development.md guide.

It would also be useful to have an explanation on the point of the Docker deploy. Here is a suggestion, if I understand the purpose correctly.

## Development

If you'd like to get the LangUI.dev site locally, you can run using Docker and the prebuild image:

docker run -d -t -p ...

Or, you can manually compile it yourself if you prefer. This is useful if you are contributing changes from a branch and would like to test them out locally.

#clone the code 
git clone https://github.com/LangbaseInc/langui.git 
...
@ahmadbilaldev
Copy link
Collaborator

Thanks for the feedback. Will send fixes.

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

No branches or pull requests

2 participants