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

docs: fix remaining broken links for both typescript and python @bhargavyagnik #549

Merged
merged 3 commits into from
Mar 11, 2025

Conversation

bhargavyagnik
Copy link
Contributor

Which issue(s) does this pull-request address?

Solved #543.

Updated links to existing docs.

Now, as per link checker, the missing links are only
Errors in docs/README.md

  • [ERROR] file:///typescript/docs/backend.md%23providers-implementations | Cannot find file
  • [ERROR] file:///typescript/docs/tools.md%23using-the-mcptool-class | Cannot find file
  • [ERROR] file:///python/tools.md%23using-the-customtool-python-functions | Cannot find file
  • [ERROR] file:///python/tools.md%23mcp-tool | Cannot find file
  • [ERROR] file:///python/docs/agents.md%23creating-your-own-agent | Cannot find file
  • [ERROR] file:///python/backend.md%23supported-providers | Cannot find file

But, this is an issue with fragments. The links are working fine with readme, IDE and website. The link-checker has an issue with finding anchor links in the code. So I will mention this in the PR submitted #542

Closes: #543

Description

Checklist

General

Code quality checks

  • Linting passes: Python poe lint or poe lint --fix / TypeScript yarn lint or yarn lint:fix
  • Formatting is applied: Python poe format or poe format --fix / TypeScript: yarn format or yarn format:fix
  • Static type checks pass: Python poe type-check

Testing

  • Unit tests pass: Python poe test --type unit / TypeScript yarn test:unit
  • E2E tests pass: Python poe test --type e2e / TypeScript: yarn test:e2e
  • Integration tests pass: Python poe test --type integration
  • Tests are included (for bug fixes or new features)

Documentation

  • Documentation is updated
  • Embedme embeds code examples in docs. To update after edits, run: Python poe docs --type build

Signed-off-by: bhargavyagnik <bhargavyagnik99@gmail.com>
Signed-off-by: bhargavyagnik <bhargavyagnik99@gmail.com>
Signed-off-by: bhargavyagnik <bhargavyagnik99@gmail.com>
@bhargavyagnik bhargavyagnik requested review from a team as code owners March 10, 2025 19:21
Copy link
Contributor

@Tomas2D Tomas2D left a comment

Choose a reason for hiding this comment

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

Thank you!

@Tomas2D Tomas2D merged commit ac949ea into i-am-bee:main Mar 11, 2025
5 checks passed
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.

docs: Fix broken links
2 participants