docs: update README and ARCHITECTURE to reflect current codebase#97
Merged
docs: update README and ARCHITECTURE to reflect current codebase#97
Conversation
- Add codecov badge - Update workspace structure (7 crates: added executor, media, pipeline) - Replace worker/scanner commands with unified command - Add development infrastructure section (Docker Compose) - Update ARCHITECTURE.md with new crates and CLI commands - Sync Chinese README with English version
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
Greptile SummaryThis PR updates documentation to accurately reflect the current codebase structure after recent refactoring. All workspace crates, CLI commands, and features documented match the actual implementation in Key Changes:
Note:
|
| Filename | Overview |
|---|---|
| ARCHITECTURE.md | Updated workspace structure, added CLI commands, video encoding, and source/sink pattern documentation. All changes accurately reflect current codebase. |
| README.md | Added codecov badge, updated workspace table to 7 crates, modernized Quick Start with unified roboflow run command, added development infrastructure section. |
| README_zh.md | Chinese translation synchronized with English README. All changes mirror README.md accurately. |
Last reviewed commit: 6baaff6
Code Review SummaryStatus: 1 Issue Found | Recommendation: Address before merge Overview
Issue Details (click to expand)WARNING
Other Observations (not in diff)Issues found in unchanged code that cannot receive inline comments:
Files Reviewed (4 files)
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
27
to
+34
| |-------|---------|-----------| | ||
| | `roboflow-core` | Foundation types, error handling, registry | `RoboflowError`, `CodecValue`, `TypeRegistry` | | ||
| | `roboflow-storage` | Storage abstraction layer | `Storage`, `LocalStorage`, `S3Storage`, `StorageFactory` | | ||
| | `roboflow-dataset` | Dataset format writers | `LerobotWriter`, `DatasetWriter`, `ImageData` | | ||
| | `roboflow-distributed` | Distributed coordination via TiKV | `TiKVClient`, `BatchController`, `Worker`, `Catalog` | | ||
| | `roboflow-sources` | Data source implementations | `BagSource`, `McapSource`, `RrdSource` | | ||
| | `roboflow-sinks` | Data sink implementations | `LerobotSink`, `ZarrSink`, `DatasetFrame` | | ||
| | `roboflow-executor` | Stage-based task executor | `StageExecutor`, `Pipeline`, `ExecutionPolicy`, `SlotPool` | | ||
| | `roboflow-media` | Image and video encoding/decoding | `ImageData`, `VideoEncoder`, `ConcurrentVideoEncoder` | | ||
| | `roboflow-dataset` | Dataset format writers and sources | `LerobotWriter`, `DatasetWriter`, `Source`, `BagSource`, `McapSource` | | ||
| | `roboflow-pipeline` | Pipeline execution and stages | `DatasetPipelineExecutor`, `DiscoverStage`, `ConvertStage`, `MergeStage` | | ||
| | `roboflow-distributed` | Distributed coordination via TiKV | `TiKVClient`, `BatchController`, `Worker`, `Scanner`, `Finalizer` | |
There was a problem hiding this comment.
CLAUDE.md still documents 5 crates instead of 7. Should update it to match this table.
Suggested change
| |-------|---------|-----------| | |
| | `roboflow-core` | Foundation types, error handling, registry | `RoboflowError`, `CodecValue`, `TypeRegistry` | | |
| | `roboflow-storage` | Storage abstraction layer | `Storage`, `LocalStorage`, `S3Storage`, `StorageFactory` | | |
| | `roboflow-dataset` | Dataset format writers | `LerobotWriter`, `DatasetWriter`, `ImageData` | | |
| | `roboflow-distributed` | Distributed coordination via TiKV | `TiKVClient`, `BatchController`, `Worker`, `Catalog` | | |
| | `roboflow-sources` | Data source implementations | `BagSource`, `McapSource`, `RrdSource` | | |
| | `roboflow-sinks` | Data sink implementations | `LerobotSink`, `ZarrSink`, `DatasetFrame` | | |
| | `roboflow-executor` | Stage-based task executor | `StageExecutor`, `Pipeline`, `ExecutionPolicy`, `SlotPool` | | |
| | `roboflow-media` | Image and video encoding/decoding | `ImageData`, `VideoEncoder`, `ConcurrentVideoEncoder` | | |
| | `roboflow-dataset` | Dataset format writers and sources | `LerobotWriter`, `DatasetWriter`, `Source`, `BagSource`, `McapSource` | | |
| | `roboflow-pipeline` | Pipeline execution and stages | `DatasetPipelineExecutor`, `DiscoverStage`, `ConvertStage`, `MergeStage` | | |
| | `roboflow-distributed` | Distributed coordination via TiKV | `TiKVClient`, `BatchController`, `Worker`, `Scanner`, `Finalizer` | | |
| |-------|---------|-----------| | |
| | `roboflow-core` | Foundation types, error handling, registry | `RoboflowError`, `CodecValue`, `TypeRegistry` | | |
| | `roboflow-storage` | Storage abstraction layer | `Storage`, `LocalStorage`, `S3Storage`, `StorageFactory` | | |
| | `roboflow-executor` | Stage-based task executor | `StageExecutor`, `Pipeline`, `ExecutionPolicy`, `SlotPool` | | |
| | `roboflow-media` | Image and video encoding/decoding | `ImageData`, `VideoEncoder`, `ConcurrentVideoEncoder` | | |
| | `roboflow-dataset` | Dataset format writers and sources | `LerobotWriter`, `DatasetWriter`, `Source`, `BagSource`, `McapSource` | | |
| | `roboflow-pipeline` | Pipeline execution and stages | `DatasetPipelineExecutor`, `DiscoverStage`, `ConvertStage`, `MergeStage` | | |
| | `roboflow-distributed` | Distributed coordination via TiKV | `TiKVClient`, `BatchController`, `Worker`, `Scanner`, `Finalizer` | |
Context Used: Context from dashboard - CLAUDE.md (source)
Prompt To Fix With AI
This is a comment left during a code review.
Path: ARCHITECTURE.md
Line: 27-34
Comment:
`CLAUDE.md` still documents 5 crates instead of 7. Should update it to match this table.
```suggestion
|-------|---------|-----------|
| `roboflow-core` | Foundation types, error handling, registry | `RoboflowError`, `CodecValue`, `TypeRegistry` |
| `roboflow-storage` | Storage abstraction layer | `Storage`, `LocalStorage`, `S3Storage`, `StorageFactory` |
| `roboflow-executor` | Stage-based task executor | `StageExecutor`, `Pipeline`, `ExecutionPolicy`, `SlotPool` |
| `roboflow-media` | Image and video encoding/decoding | `ImageData`, `VideoEncoder`, `ConcurrentVideoEncoder` |
| `roboflow-dataset` | Dataset format writers and sources | `LerobotWriter`, `DatasetWriter`, `Source`, `BagSource`, `McapSource` |
| `roboflow-pipeline` | Pipeline execution and stages | `DatasetPipelineExecutor`, `DiscoverStage`, `ConvertStage`, `MergeStage` |
| `roboflow-distributed` | Distributed coordination via TiKV | `TiKVClient`, `BatchController`, `Worker`, `Scanner`, `Finalizer` |
```
**Context Used:** Context from `dashboard` - CLAUDE.md ([source](https://app.greptile.com/review/custom-context?memory=2ad098e3-954c-4e7a-822a-5c9a0fd6a8a2))
How can I resolve this? If you propose a fix, please make it concise.
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
| ### Manage Jobs | ||
|
|
||
| ```bash | ||
| roboflow jobs list |
There was a problem hiding this comment.
WARNING: roboflow jobs list and roboflow jobs get are deprecated commands that will return an error at runtime
The jobs command has been replaced by the batch command system. Per src/bin/commands/jobs.rs, all jobs subcommands (except --help) return a deprecation error:
Error: The 'jobs' command has been deprecated.
Please use the 'batch' command instead:
- Use 'roboflow batch submit' to submit new batch jobs
- Use 'roboflow batch list' to list batch jobs
...
The ### Manage Jobs section should either remove roboflow jobs list / roboflow jobs get entirely, or add a deprecation notice. Consider replacing with:
Suggested change
| roboflow jobs list | |
| roboflow batch list |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
roboflow-executor,roboflow-media,roboflow-pipelineroboflow-hdf5roboflow worker/roboflow scannercommands with unifiedroboflow runcommandChanges
README.md & README_zh.md
[](https://codecov.io/gh/archebase/roboflow)roboflow runcommand and role optionsFINALIZER_POLL_INTERVAL_SECSenvironment variableARCHITECTURE.md
ConcurrentVideoEncoderTest Plan
Cargo.tomlworkspace memberssrc/bin/roboflow.rs