ArgLab / ArgLab/writing_observer
Documentation overview
- Dominant language
- Python
- Stars
- 12
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
The documentation needs to be updated on 2 broad levels:
1. Developer - system architecture, how to write modules, why code exists, etc
2. Admin - install / startup (LMS)
Some pieces in my notebook about things that need documentation:
- [ ] Many steps for successful setup - install, settings, LMSs, rosters, etc
- [ ] How to do things in the code - write reducers, add an LMS, adding a dashboard (Dash and Nextjs)
- [ ] Deployment how-to
- [ ] Documenting the code
- [ ] Using PMSS
- [ ] Restreaming events
- [ ] Query language
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or entry points are named. Start by inventorying the setup, architecture, module and reducer guidance, LMS and dashboard work, deployment, PMSS, event restreaming, and query language notes; done means these developer and admin topics have clear, usable documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nextjs, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100