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

doc: add windows powershell commands in client cli documentation #2228

Merged
merged 3 commits into from
Jan 17, 2025

Conversation

Alenar
Copy link
Collaborator

@Alenar Alenar commented Jan 16, 2025

Content

This PR add windows powershell commands instruction in the docusaurus website when building or running the mithril-client CLI.

Tabs are added on the page so users can switch between previous commands, that works for Linux and Mac, and the new windows version.

This PR also add syntax highlighting for powershell and bash scripts.

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update documentation website (if relevant)

Issue(s)

Closes #2199

@Alenar Alenar self-assigned this Jan 16, 2025
Copy link

github-actions bot commented Jan 16, 2025

Test Results

    4 files  ±0     52 suites  ±0   10m 35s ⏱️ +4s
1 493 tests ±0  1 493 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 749 runs  ±0  1 749 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 5588324. ± Comparison against base commit ff02ea5.

♻️ This comment has been updated with latest results.

@Alenar Alenar force-pushed the djo/2199/windows_commands_for_client-cli_doc branch from 866718b to 5e5ca07 Compare January 16, 2025 16:43
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

@Alenar Alenar temporarily deployed to testing-preview January 16, 2025 16:52 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet January 16, 2025 16:52 — with GitHub Actions Inactive
@Alenar Alenar force-pushed the djo/2199/windows_commands_for_client-cli_doc branch from 5e5ca07 to 4c3a3a1 Compare January 16, 2025 16:56
@Alenar Alenar temporarily deployed to testing-preview January 16, 2025 17:05 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet January 16, 2025 17:05 — with GitHub Actions Inactive
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

docs/website/root/manual/develop/nodes/mithril-client.md Outdated Show resolved Hide resolved
docs/website/root/manual/develop/nodes/mithril-client.md Outdated Show resolved Hide resolved
docs/website/root/manual/develop/nodes/mithril-client.md Outdated Show resolved Hide resolved
@Alenar Alenar force-pushed the djo/2199/windows_commands_for_client-cli_doc branch from 4c3a3a1 to 5588324 Compare January 16, 2025 18:12
@Alenar Alenar temporarily deployed to testing-preview January 16, 2025 18:26 — with GitHub Actions Inactive
@Alenar Alenar temporarily deployed to testing-sanchonet January 16, 2025 18:26 — with GitHub Actions Inactive
@Alenar Alenar merged commit c989531 into main Jan 17, 2025
43 checks passed
@Alenar Alenar deleted the djo/2199/windows_commands_for_client-cli_doc branch January 17, 2025 09:00
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.

Mithril client does not work in Windows Power Shell
4 participants