Skip to content

Documentation Cleanup#2053

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

Documentation Cleanup#2053
ChuckTerry wants to merge 3 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 and link updates only; no runtime code, dependencies, or build behavior changes.

Overview
Documentation-only cleanup across root and module READMEs: fixes broken or outdated links, standardizes GitHub capitalization, and improves markdown formatting.

In CONTRIBUTING.md, workflow headings and body text use GitHub consistently, and the index.rst doc entry points to docs/labelbox/index.rst instead of the old path.

The root README.md updates the social badge to X (x.com), refreshes the API key doc link, adds a Provenance TOC entry (and drops the stale “Develop with AI” link), uses GitHub Issue wording, and tags Jupyter and SLSA verification snippets as python / bash fenced blocks.

libs/labelbox/README.md points integration-test API key help at the current create-api-key reference and restores a closing fence on the docs command block. libs/lbox-clients and libs/lbox-example READMEs drop the dead “experimental feature” doc link and shorten the experimental disclaimer to plain HTML.

Reviewed by Cursor Bugbot for commit 5ec8206. 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