Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation #315

Open
4 tasks
vGsteiger opened this issue Sep 8, 2024 · 0 comments · May be fixed by #330
Open
4 tasks

Improve Documentation #315

vGsteiger opened this issue Sep 8, 2024 · 0 comments · May be fixed by #330
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@vGsteiger
Copy link
Collaborator

vGsteiger commented Sep 8, 2024

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).
@vGsteiger vGsteiger added the documentation Improvements or additions to documentation label Sep 8, 2024
@Danidite Danidite assigned Danidite and unassigned Danidite Sep 26, 2024
@vGsteiger vGsteiger self-assigned this Sep 30, 2024
@vGsteiger vGsteiger linked a pull request Sep 30, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants