langui icon indicating copy to clipboard operation
langui copied to clipboard

Docs: Clarify Docker instructions

Open MichaelCurrin opened this issue 1 year ago • 1 comments

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 
...

MichaelCurrin avatar Aug 29 '24 13:08 MichaelCurrin