Skip to content

Improve Documentation #315

Open
Open
@vGsteiger

Description

Is your feature request related to a problem? Please describe.
The documentation could be improved for better clarity and usability. It is currently frustrating when trying to deploy and execute the small_sync_example due to unclear instructions and missing details.

Describe the solution you'd like

  • Clear Expected Output: Specify the expected output for each step and where to find it (e.g., which DynamoDB table to check, which CloudWatch log group to review).
  • Early Introduction of Concepts: Introduce the concept of workflow_id earlier in the documentation.
  • Prerequisites: Include Python version requirement (3.12+), mention the need to install crane, and the necessity of exporting keys early on (highlight the installation guide better).
  • Memory Limit Clarification: Explain the memory constraints for poetry run caribou deploy_remote_cli and provide a working default (apparently everything above 3008 fails).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions