Skip to content

Conversation

@besaleli
Copy link
Member

@besaleli besaleli commented Nov 25, 2025

  • Inlines CONTRIBUTING.md and CODE_OF_CONDUCT.md into docs
  • Fixes broken links
  • centered badges on docs homepage
  • the diagram was a little hard to see in dark mode, so I changed the theme
  • add footnote about glibc

Does not fix the following, so leaving as an FYI:

  • Doc file 'cookbooks/token-classification-ner.md' contains a link 'sequence-classification-sentiment.md', but the target 'cookbooks/sequence-classification-sentiment.md' is not found among documentation files.
  • Doc file 'cookbooks/token-classification-ner.md' contains a link 'embeddings-similarity.md', but the target 'cookbooks/embeddings-similarity.md' is not found among documentation files.
  • Doc file 'cookbooks/token-classification-ner.md' contains a link '../index.md#-installation', but the doc 'index.md' does not contain an anchor '#-installation'.

Test locally by running make docs and going to http://localhost:8000. Let me know if you're happy with the changes!

@besaleli besaleli requested a review from angpt November 25, 2025 08:47
@besaleli besaleli added the documentation Improvements or additions to documentation label Nov 25, 2025
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codspeed-hq
Copy link

codspeed-hq bot commented Nov 25, 2025

CodSpeed Performance Report

Merging #135 will not alter performance

Comparing docs/fix-broken-links (99e106a) with main (2be28bb)

Summary

✅ 20 untouched
⏩ 20 skipped1

Footnotes

  1. 20 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

Copy link
Contributor

@angpt angpt left a comment

Choose a reason for hiding this comment

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

Fixed broken links in the cookbook with this PR.

@angpt angpt merged commit ad72c13 into main Nov 25, 2025
1 check passed
@angpt angpt deleted the docs/fix-broken-links branch November 25, 2025 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants