Add documentation on how to run the Burr UI server

Open Beginner friendly
#272 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation

Research direction

Start by locating the existing documentation entry point and the Burr UI server's installation and launch instructions. Document optional commands such as creating demo data, then cover the UI capabilities requested in the issue. Done means a newcomer can use this page as the reference for installing, running, and exploring the UI.

Written by the indexing model from the issue text.

Description

area/ui good first issue kind/documentation priority/low

Is your feature request related to a problem? Please describe.
There is no section in the documentation on how to run the Burr UI server.

Describe the solution you'd like

  1. create a section in the documentation about the UI.
  2. provide details on installation
  3. how to run it
  4. document optional commands, e.g. creating demo data or not
  5. document what one can do with the UI: see things by project, run some demos, etc.

Describe alternatives you've considered
N/A

Additional context
This should be the reference documentation to point someone to how to install / run things.

Dominant language
Python
Stars
2.6k
Forks
196
Avg merge
5d 13h
Merged PRs (30d)
14

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/burr

All issues in apache/burr

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.