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

Updated introduction #269

Merged
merged 1 commit into from
Feb 19, 2025
Merged

Updated introduction #269

merged 1 commit into from
Feb 19, 2025

Conversation

iesahin
Copy link
Owner

@iesahin iesahin commented Feb 19, 2025

Description by Callstackai

This PR updates the introduction section of the documentation for Xvc, providing a more detailed overview of its features and usage examples.

Diagrams of code changes
sequenceDiagram
    participant User
    participant Xvc
    participant Storage
    participant Pipeline

    User->>Xvc: Initialize project (xvc init)
    Xvc-->>User: Create .xvc/ directory

    User->>Xvc: Track files (xvc file track)
    Xvc-->>User: Calculate file digests & store in cache

    User->>Storage: Configure storage (xvc storage new)
    Storage-->>User: Storage configured

    User->>Storage: Send/bring files (xvc file send/bring)
    Storage-->>User: Files transferred to/from storage

    User->>Pipeline: Create pipeline step (xvc pipeline step new)
    Pipeline-->>User: Step created

    User->>Pipeline: Add dependencies (xvc pipeline step dependency)
    Pipeline-->>User: Dependencies configured

    User->>Pipeline: Run pipeline (xvc pipeline run)
    Pipeline-->>User: Execute steps based on dependencies
Loading
Files Changed
FileSummary
book/src/intro/index.mdUpdated the introduction section with detailed descriptions and usage examples for Xvc.

This PR includes files in programming languages that we currently do not support. We have not reviewed files with the extensions .md. See list of supported languages.

Copy link

netlify bot commented Feb 19, 2025

Deploy Preview for xvc ready!

Name Link
🔨 Latest commit e3807f1
🔍 Latest deploy log https://app.netlify.com/sites/xvc/deploys/67b5ac4c441ab00008a09f35
😎 Deploy Preview https://deploy-preview-269--xvc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@iesahin iesahin merged commit 99dca40 into main Feb 19, 2025
6 of 7 checks passed
@iesahin iesahin deleted the update-intro-16655 branch February 19, 2025 10:03
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.28%. Comparing base (befbaa0) to head (e3807f1).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #269      +/-   ##
==========================================
+ Coverage   71.24%   71.28%   +0.04%     
==========================================
  Files         126      126              
  Lines       14326    14326              
==========================================
+ Hits        10207    10213       +6     
+ Misses       4119     4113       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant