Skip to content

docs: fix broken inlang readme links - #8913

Open
miachillgood wants to merge 1 commit into
AppFlowy-IO:mainfrom
miachillgood:docs/fix-inlang-readme-links
Open

docs: fix broken inlang readme links#8913
miachillgood wants to merge 1 commit into
AppFlowy-IO:mainfrom
miachillgood:docs/fix-inlang-readme-links

Conversation

@miachillgood

@miachillgood miachillgood commented Aug 3, 2026

Copy link
Copy Markdown

Summary

  • replace the broken inlang editor README links with the checked-in project.inlang/settings.json entrypoint
  • keep the translation workflow documentation aligned with the repository-local inlang config

Why

Addresses #8849. The current README points to an inlang editor URL that now returns 404.

Testing

  • verified the previous inlang editor URL returns 404
  • not run otherwise (docs-only change)

Summary by Sourcery

Documentation:

  • Adjust README translation badge and instructions to point to the checked-in inlang project settings rather than the deprecated online editor link.

@sourcery-ai

sourcery-ai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates translation-related documentation to stop using a broken inlang online editor URL and instead reference the repository-local inlang project settings as the entrypoint for translation workflows.

File-Level Changes

Change Details Files
Redirect translation badge and workflow instructions from the broken inlang editor URL to the local in-repo inlang project configuration.
  • Change the translation badge link target from the external inlang editor URL to the local project.inlang/settings.json file.
  • Update translation instructions to reference using the checked-in inlang project settings with any preferred inlang tool instead of specifically recommending the online editor URL.
  • Preserve the existing npx inlang machine translate command while aligning its context with the new local configuration-based workflow.
README.md

Possibly linked issues


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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • Consider briefly clarifying how to use the project.inlang/settings.json (e.g., mentioning a common inlang tool or linking to inlang’s usage docs) so contributors understand what “your preferred inlang tool” concretely means.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider briefly clarifying how to use the `project.inlang/settings.json` (e.g., mentioning a common inlang tool or linking to inlang’s usage docs) so contributors understand what “your preferred inlang tool” concretely means.

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.

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