whiteducksoftware / whiteducksoftware/flock
[1.0] Align roadmap and operating guidance with the qualified release scope
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 120
- Forks
- 14
- Avg merge
- 19h 32m
- Merged PRs (30d)
- 8
Description
README and roadmap statements still describe an old schedule and broader capabilities than the qualified 1.0 slice. Operators need consistent setup, limits and interruption guidance.
Scope
- Align README, both roadmaps, onboarding and operating/migration guidance with the single-process SQLite contract.
- Document safe access, actual run controls, limits, interruption without auto-resume, native instruction/reference Skills, supported versions and configuration changes.
- Separate later recovery/retries/approvals/workspace transfer and separately qualified Dapr/CLI/Kubernetes integrations. Keep customer deployment count as a program goal rather than a fixed GA gate.
Acceptance criteria
- The maintained onboarding commands work on the candidate package and match the actual API/dashboard behavior.
- Current product pages have no conflicting release date, automatic-recovery guarantee or implied support for an unqualified deployment mode.
- Operator guidance explains overload, unknown outcomes and deliberate new work after interruption, including the current REST idempotency limitation.
Boundaries
Begin the scope/terminology corrections early; finalize operating examples once the referenced behavior is implemented. No new documentation platform.
References
- Related user-facing context: #410.
- Implementation dependencies: #439, #444, #446, #447, #450.
- README.md
- ROADMAP.md
- docs/about/roadmap.md
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 with README.md, ROADMAP.md, and docs/about/roadmap.md, then trace the onboarding and operating/migration guidance referenced in the scope. Check implementation dependencies #439, #444, #446, #447, and #450 before finalizing examples. Done means the maintained commands match the candidate package and API/dashboard behavior, with no conflicting release claims and clear guidance for limits, interruption, unknown outcomes, and current REST idempotency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100