DeployBoard / DeployBoard/deployboard-python
Update Docs
- Dominant language
- Python
- Stars
- 10
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
**Is your feature request related to a problem? Please describe.**
Lots of pages on the docs are just empty placeholders and is not very helpful.
**Describe the solution you'd like**
We need to update the docs to provide more information. I'm not sure at this time what the "minimum" would be for v1.0.0, but it needs to be enough for a new user to be able to launch the application and start using without questions.
**Describe alternatives you've considered**
None
**Additional context**
None
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no documentation files, tests, or entry points; start by inventorying the empty placeholder pages and reviewing how a new user launches the application. Define the minimum v1.0.0 guidance before editing, and consider the work done when a new user can launch and begin using the application without unanswered basic questions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100