databrickslabs / databrickslabs/ontos
[Docs]: Update README.md with MVP functionality
Open
Nobody has claimed this yet.
type/docs
- Dominant language
- Python
- Stars
- 212
- Forks
- 71
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 43
Description
Is there an existing issue for this?
- I have searched the existing issues
Problem statement
The README right now is for developers only.
Proposed Solution
Move development-related info into a separate file and focus on deployment and first steps instead.
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing README.md and identify which sections are aimed at developers versus deployment and first steps. Confirm the project's MVP functionality from the existing README, move development-related information into a separate file, and ensure the revised README clearly guides deployment and initial use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100