Skip to content

Documentation Cleanup#2053

Open
ChuckTerry wants to merge 4 commits into
Labelbox:developfrom
ChuckTerry:ct/readme-updates
Open

Documentation Cleanup#2053
ChuckTerry wants to merge 4 commits into
Labelbox:developfrom
ChuckTerry:ct/readme-updates

Conversation

@ChuckTerry

@ChuckTerry ChuckTerry commented Mar 29, 2026

Copy link
Copy Markdown
Contributor

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
Markdown-only link, branding, and formatting fixes with no runtime, security, or dependency impact.

Overview
This PR updates repository markdown only—no code or build behavior changes.

CONTRIBUTING.md standardizes GitHub capitalization (section title and workflow bullets) and points the index.rst doc entry link at docs/labelbox/index.rst instead of the old docs/source/ path.

The root README.md switches the social badge from Twitter to X (x.com), adds Provenance to the table of contents and drops the dead “Develop with AI Assistance” entry, fixes the API key doc URL to docs.labelbox.com/reference/create-api-key, uses GitHub in support text, and adds python / bash fences on the Jupyter and provenance examples.

libs/labelbox/README.md uses the same API key reference link and closes the docs code block properly. libs/lbox-clients and libs/lbox-example shorten the experimental notice and remove the link to product-release phases that no longer documents “Experimental.”

Reviewed by Cursor Bugbot for commit 89d1236. Bugbot is set up for automated code reviews on this repo. Configure here.

@ChuckTerry ChuckTerry mentioned this pull request Jun 13, 2026
4 tasks
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