Documentation Cleanup#2053
Open
ChuckTerry wants to merge 4 commits into
Open
Conversation
ChuckTerry
requested review from
KeshavSahoo,
carl-l-chua,
cyrusj89,
golchin-shahriar,
john-labelbox,
ramy1951 and
vedsirdeshmukh
March 29, 2026 02:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documentation Cleaning
I started this to fix a couple of dead links in the root
README.mdbut figured I should go ahead and hit other documentation while I was at it.CONTRIBUTING.md
README.md
Other
README.mdlinks to definition of "Experimental Feature" inlibs/lbox-clientsandlibs/lbox-exampleThis redirected to the overview page and it appears that we no longer define what an experimental feature is in the docs.libs/labelbox/README.md.Type of change
All Submissions
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.rstdoc entry link atdocs/labelbox/index.rstinstead of the olddocs/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 todocs.labelbox.com/reference/create-api-key, uses GitHub in support text, and addspython/bashfences on the Jupyter and provenance examples.libs/labelbox/README.mduses the same API key reference link and closes the docs code block properly.libs/lbox-clientsandlibs/lbox-exampleshorten 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.