Skip to content

docs: fix broken markdown links in translated readmes and examples - #340

Merged
raahulrahl merged 1 commit into
GetBindu:mainfrom
nexpectArpit:docs/fix-broken-links
Mar 8, 2026
Merged

docs: fix broken markdown links in translated readmes and examples#340
raahulrahl merged 1 commit into
GetBindu:mainfrom
nexpectArpit:docs/fix-broken-links

Conversation

@nexpectArpit

Copy link
Copy Markdown
Contributor

Summary

  • Problem: In all 7 translated README.md files (Spanish, French, Chinese, Hindi, etc.), there is a broken link pointing to docs/long-running-task-notifications.md which no longer exists. Additionally, in examples/README.md, there are broken links pointing to ../openapi.yaml (which doesn't exist) and an incorrect path to LICENSE.md.
  • Why it matters: Broken links confuse new users and developers trying to navigate the repository documentation and examples, leading to a poorer developer experience.
  • What changed:
    • Updated all 7 translated READMEs to point to the correct new file: docs/NOTIFICATIONS.md.
    • Removed the dead openapi.yaml link from examples/README.md.
    • Fixed the LICENSE.md link in examples/README.md to point to the correct root directory (../LICENSE.md).

Change Type (select all that apply)

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Security hardening
  • Tests
  • Chore/infra

Scope (select all touched areas)

  • Server / API endpoints
  • Extensions (DID, x402, etc.)
  • Storage backends
  • Scheduler backends
  • Observability / monitoring
  • Authentication / authorization
  • CLI / utilities
  • Tests
  • Documentation
  • CI/CD / infra

User-Visible / Behavior Changes

None. Purely markdown documentation link fixes.

Security Impact (required)

  • New permissions/capabilities? No
  • Secrets/credentials handling changed? No
  • New/changed network calls? No
  • Database schema/migration changes? No
  • Authentication/authorization changes? No
  • If any Yes, explain risk + mitigation: N/A

Event tags: apertre3.0 easy

@raahulrahl raahulrahl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice one.

@raahulrahl
raahulrahl merged commit a209372 into GetBindu:main Mar 8, 2026
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.

3 participants