Skip to content

docs: add French (fr-FR) and German (de-DE) translations#6774

Closed
JesusMP22 wants to merge 4 commits into
Scottcjn:mainfrom
JesusMP22:docs-more-translations
Closed

docs: add French (fr-FR) and German (de-DE) translations#6774
JesusMP22 wants to merge 4 commits into
Scottcjn:mainfrom
JesusMP22:docs-more-translations

Conversation

@JesusMP22
Copy link
Copy Markdown
Contributor

Documentation Translations

Added README translations for:

  • French (fr-FR) — docs/fr-FR/README.md
  • German (de-DE) — docs/de-DE/README.md

Following the same format as existing translations.

Wallet: jesusmp

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

Welcome to RustChain! Thanks for your first pull request.

Before we review, please make sure:

  • Non-doc PRs have a BCOS-L1 or BCOS-L2 label
  • Doc-only PRs are exempt from BCOS tier labels when they only touch docs/**, *.md, or common image/PDF files
  • New code files include an SPDX license header
  • You've tested your changes against the live node

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100) | Critical (100-150)

A maintainer will review your PR soon. Thanks for contributing!

@github-actions github-actions Bot added documentation Improvements or additions to documentation BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) size/M PR: 51-200 lines labels Jun 1, 2026
Copy link
Copy Markdown

@huhaha120 huhaha120 left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution. I am requesting changes because the FreeBSD installer path currently cannot complete a clean install, and the service/docs do not line up with the miner CLI that exists in this repository.

I found three blocking issues:

  • the installer downloads a miner path that is not present on main, so curl -fsSL exits under set -e before installation completes;
  • the rc.d service does not pass or load the wallet configured during install, so the service will not mine to the requested wallet;
  • the FreeBSD docs show a --node CLI flag that the current miner parser does not support.

These should be fixed before merging so users do not follow a one-line installer that fails or starts mining with the wrong configuration.

Comment thread install-miner-freebsd.sh
@@ -0,0 +1,152 @@
#!/bin/bash
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Blocking for FreeBSD users: /bin/bash is not available in a base FreeBSD install, and when bash is installed from packages it is normally /usr/local/bin/bash. The documented install commands also pipe into bash, so a clean FreeBSD host can fail before any dependency installation runs. Either make this script POSIX /bin/sh compatible, or document/bootstrap pkg install bash before users invoke it.

Comment thread install-miner-freebsd.sh
# Download miner client
echo "[3/5] Downloading miner client..."
cd /opt/rustchain
curl -fsSL "https://raw.githubusercontent.com/Scottcjn/Rustchain/main/miners/rustchain_miner.py" -o rustchain_miner.py
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Blocking: this URL currently points at miners/rustchain_miner.py, which does not exist on main and is not added by this PR. Because the script runs with set -euo pipefail, curl -fsSL ... -o rustchain_miner.py exits here and the installer never creates or starts the rc.d service. Please point this at an existing FreeBSD-compatible miner artifact, or add the artifact and any required companion files such as fingerprint_checks.py/checksums.

Comment thread install-miner-freebsd.sh

pidfile="/var/run/rustchain_miner.pid"
command="/usr/sbin/daemon"
command_args="-f -p ${pidfile} -u rustchain /usr/local/bin/python3 /opt/rustchain/rustchain_miner.py"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Blocking: the installer writes /opt/rustchain/config.env, but the generated rc.d script never sources it and this command does not pass --wallet. The current miner CLI accepts --wallet and otherwise falls back to generating its own wallet, so service rustchain_miner start will not use the ${WALLET_NAME} supplied to the installer. Please load/export the config in the rc.d script or pass the wallet explicitly in command_args.

Comment thread miners/freebsd/README.md
pip3 install requests

# Run miner directly
python3 rustchain_miner.py --node https://rustchain.org --wallet your-wallet-name
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Docs mismatch: the current miner parser in miners/linux/rustchain_linux_miner.py exposes --wallet, dry-run/show-payload options, and Warthog options, but no --node flag. This command will fail with an unrecognized argument unless this PR also adds a FreeBSD miner implementation that supports --node.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

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

Great contribution! 🔍 Reviewed and looks solid.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for contributing to RustChain. Approved.

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

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

Solid PR! The changes are well-thought-out and the code quality is high.

@Scottcjn
Copy link
Copy Markdown
Owner

Scottcjn commented Jun 2, 2026

Closing as superseded by #6776, which is the superset of this translation batch (same languages plus more). Consolidating to one PR keeps review clean — thanks @JesusMP22.

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

Labels

BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) documentation Improvements or additions to documentation size/M PR: 51-200 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants