Skip to content

Docs: add features documentation for mithril-client library #2358

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Mar 10, 2025
Merged

Docs: add features documentation for mithril-client library #2358

merged 5 commits into from
Mar 10, 2025

Conversation

dlachaume
Copy link
Collaborator

@dlachaume dlachaume commented Mar 7, 2025 •
edited
Loading

Content

This PR includes the documentation of optional Cargo features available in mithril-client which provides a list of features, their purpose, and their default status.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • All check jobs of the CI have succeeded
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)
    • Add dev blog post (if relevant)
    • Add ADR blog post or Dev ADR entry (if relevant)
    • No new TODOs introduced

@dlachaume dlachaume self-assigned this Mar 7, 2025
@dlachaume dlachaume marked this pull request as ready for review March 7, 2025 14:43
sfauvel
sfauvel approved these changes Mar 7, 2025
View reviewed changes
Copy link
Collaborator

@sfauvel sfauvel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 7, 2025 •
edited
Loading

Test Results

    3 files  ±0     56 suites  ±0   10m 17s ⏱️ -12s
1 713 tests ±0  1 713 ✅ ±0  0 💤 ±0  0 ❌ ±0 
2 105 runs  ±0  2 105 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit bedea5f. ± Comparison against base commit a15435c.

♻️ This comment has been updated with latest results.

@dlachaume dlachaume temporarily deployed to testing-preview March 7, 2025 14:49 — with GitHub Actions Inactive
jpraynaud
jpraynaud approved these changes Mar 7, 2025
View reviewed changes
@dlachaume dlachaume temporarily deployed to testing-preview March 7, 2025 15:26 — with GitHub Actions Inactive
Alenar
Alenar approved these changes Mar 7, 2025
View reviewed changes
Copy link
Collaborator

@Alenar Alenar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dlachaume dlachaume force-pushed the dlachaume/add-features-documentation-in-client-lib branch from 8afd99e to 815366e Compare March 10, 2025 08:45
@dlachaume dlachaume temporarily deployed to testing-preview March 10, 2025 08:54 — with GitHub Actions Inactive
@dlachaume dlachaume force-pushed the dlachaume/add-features-documentation-in-client-lib branch from 815366e to bedea5f Compare March 10, 2025 10:23
@dlachaume dlachaume temporarily deployed to testing-preview March 10, 2025 10:31 — with GitHub Actions Inactive
@dlachaume dlachaume merged commit 39e5a58 into main Mar 10, 2025
37 checks passed
@dlachaume dlachaume deleted the dlachaume/add-features-documentation-in-client-lib branch March 10, 2025 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Alenar Alenar Alenar approved these changes

@sfauvel sfauvel sfauvel approved these changes

@jpraynaud jpraynaud jpraynaud approved these changes

Assignees

@dlachaume dlachaume

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dlachaume @Alenar @sfauvel @jpraynaud