Skip to content

Add translation contribution guide and update links #88

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

Merged
merged 1 commit into from
Jul 18, 2025

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Jul 18, 2025

Summary

This pull request introduces comprehensive documentation for contributing translations to GhostBSD tools. It includes:

  • New translation contribution guide (translations/index.md) explaining how to assist with translations.
  • Detailed documentation (translate-python.md) on translating Python-based tools and workflows.
  • Updated contributor documentation links to directly reference .md files.
  • Inclusion of the translation docs in the main index.md navigation.

Summary by Sourcery

Add a new translation contribution guide for GhostBSD Python tools, update contributor documentation links to use explicit .md extensions, and include the translations section in the main navigation.

Enhancements:

  • Update contributor document links to use .md extensions
  • Include translations section in the main documentation navigation

Documentation:

  • Add translations/index.md with guidelines for translating Python-based GhostBSD tools

- Added `contributor/translations/index.md` with details on contributing translations for GhostBSD tools.
- Created `contributor/translations/translate-python.md` to explain the Python translation process and workflows in detail.
- Updated contributor links in `contributor/index.md` to include `.md` file extensions.
- Included the new translation documentation in the main `index.md`.
@ericbsd ericbsd requested review from a team as code owners July 18, 2025 01:45
Copy link
Contributor

sourcery-ai bot commented Jul 18, 2025

Reviewer's Guide

This PR standardizes documentation links to .md, integrates translation docs into the main navigation, and introduces a dedicated translation contribution guide for GhostBSD’s Python tools.

Flow diagram for documentation navigation update

flowchart TD
    A[Main index.md navigation] --> B[Add link to contributor/translations/index]
    B --> C[User accesses translation contribution guide]
    A --> D[Other contributor documentation links updated to .md]
    D --> E[Consistent navigation experience]
Loading

File-Level Changes

Change Details Files
Standardize contributor documentation links to .md extension
  • Updated Getting Started link to include .md
  • Updated Contributing to Ports link to include .md
  • Updated Contributing Translations link to include .md
contributor/index.md
Add translations section to main navigation
  • Inserted contributor/translations/index in index.md navigation
index.md
Create translation contribution guide
  • Added guide structure for translation contributions
  • Listed Python-based tools to be translated
  • Linked to Python translation workflow guide
contributor/translations/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ericbsd - I've reviewed your changes - here's some feedback:

  • It looks like you reference translate-python.md in the translations index but didn’t actually add that file—please include the Python translation guide in this PR.
  • For consistency with the contributor index, update the main index nav to use the .md suffix for the translations entry (e.g., contributor/translations/index.md).
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- It looks like you reference translate-python.md in the translations index but didn’t actually add that file—please include the Python translation guide in this PR.
- For consistency with the contributor index, update the main index nav to use the .md suffix for the translations entry (e.g., contributor/translations/index.md).

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ericbsd ericbsd merged commit 15801de into master Jul 18, 2025
4 checks passed
@ericbsd ericbsd deleted the python-translation branch July 18, 2025 20:23
@github-project-automation github-project-automation bot moved this from In Review to Done in Documentation Management Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant