Skip to content

Documentation Cleanup#2053

Open
ChuckTerry wants to merge 1 commit intoLabelbox:developfrom
ChuckTerry:ct/readme-updates
Open

Documentation Cleanup#2053
ChuckTerry wants to merge 1 commit intoLabelbox:developfrom
ChuckTerry:ct/readme-updates

Conversation

@ChuckTerry
Copy link
Copy Markdown
Contributor

@ChuckTerry ChuckTerry commented Mar 29, 2026

Description

Documentation Cleaning

I started this to fix a couple of dead links in the root README.md but figured I should go ahead and hit other documentation while I was at it.

CONTRIBUTING.md

  • Fix Capitalization "Github" -> "GitHub" in several places
  • Contribution Guide
    • General Guidelines
      • Fixed Dead Link "index.rst"

README.md

  • Badges
    • Twitter -> X
  • Labelbox
    • Table of Contents
      • Remove Deadlink "Develop with AI"
      • Add Missing Section "Provenance"
    • Quick Start
      • Generate an API key
        • Fixed Dead Link "Account > API Keys"
      • Validate Installation and API Key
        • Fix Capitalization "Github" -> "GitHub"
    • Jupyter Notebooks
      • Added python syntax highlighting to code block
    • Provenance
      • Added bash syntax highlighting to the code block

Other

  • Removed README.md links to definition of "Experimental Feature" in libs/lbox-clients and libs/lbox-example This redirected to the overview page and it appears that we no longer define what an experimental feature is in the docs.
  • Fixed Dead Link to "Labelbox API key docs" in libs/labelbox/README.md.

Type of change

  • Document change (fix typo or modifying any markdown files, code comments or anything in the examples folder only)

All Submissions

  • Have you followed the guidelines in our Contributing document?
    • No, there's no reason for me to install devdependencies or spin up a virtual environment for changes to markdown documentation
  • Have you provided a description?
  • Are your changes properly formatted?

Note

Low Risk
Low risk documentation-only changes that update links, headings, and code fences without affecting runtime behavior.

Overview
Fixes and modernizes documentation across README.md, CONTRIBUTING.md, and module READMEs by correcting dead/outdated links (notably API key and docs index paths) and standardizing GitHub capitalization.

Updates the root README’s badges (Twitter→X), table of contents (adds Provenance, removes a dead entry), and improves code block syntax highlighting. Cleans up module docs by updating the LABELBOX_TEST_API_KEY link and simplifying the “Experimental” notice in libs/lbox-* READMEs.

Written by Cursor Bugbot for commit c54fa29. This will update automatically on new commits. Configure here.

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