Skip to content

Restructure the org profile README and remove dead links - #29

Merged
rahlk merged 1 commit into
mainfrom
docs/issue-28-readme-cleanup
Aug 3, 2026
Merged

Restructure the org profile README and remove dead links#29
rahlk merged 1 commit into
mainfrom
docs/issue-28-readme-cleanup

Conversation

@rahlk

@rahlk rahlk commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Motivation and Context

Closes #28.

Rebuilds the org profile README on the shape of the Model Context Protocol org profile README: logo, badges, tagline, nav, intro, Getting Started, Project Structure, then the tail sections.

Two deliberate departures from MCP, because CLDK is a library and MCP is a protocol: the badge row stays, and one code example stays. MCP's call to action is "read the spec"; CLDK's is pip install cldk.

Link fixes

  • codeanalyzer-ts and cocoa-py resolved only via GitHub rename redirects
  • the Discord link was a discord.com/channels deep-link, resolving only for existing members
  • the Contact table displayed rangeet.pan@ibm.com while the mailto: pointed at gmail
  • the <picture> fallback <img> had no src attribute
  • badge.fury.io and opensource.org/licenses both redirected; now canonical

Removed
The Supported Languages table (backends moved into Project Structure, status collapsed to one sentence), the Language-Specific Analysis Backends section, Build with CLDK and every COCOA reference, the duplicated Documentation and Examples section, the second code example, the commented-out npm badge, and links to the codeanalyzer-go/codeanalyzer-rust stubs and the 0.0.0-pre-alpha npm package.

143 lines to 104.

How Has This Been Tested?

Every URL extracted from the rendered file and checked for both status and redirect. All return 200 with no redirect, except discord.gg/zEjz9YrmqN, whose 301 to discord.com/invite/… is Discord's own canonical shortener and is by design.

All four shields.io badge images return 200. The relative CONTRIBUTING.md target and both logo assets exist. Every mailto: was compared against its display text — all three now match. Verified zero occurrences of "cocoa".

Rendering on the actual org profile page cannot be verified before merge.

Breaking Changes

None. Documentation only.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the Codellm-Devkit Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally — N/A, no tests in this repo
  • I have added appropriate error handling — N/A, documentation only
  • I have added or updated documentation as needed

Additional context

Propagation sweep. cocoa-py and the discord.com/channels deep-link appear nowhere else in the org. codeanalyzer-ts is widespread but almost always as the legitimate binary/tool name — the published npm package is codeanalyzer-typescript with bin cants. Two genuine stale repo references remain elsewhere and are filed separately:

  • codeanalyzer-typescript/packaging/python/pyproject.toml:27Repository = "https://github.com/codellm-devkit/codeanalyzer-ts", which ships as published package metadata
  • codeanalyzer-typescript/packaging/homebrew/generate_formula.sh:15,21 — stale REPO example and default

A python-sdk test fixture also contains the string as recorded path data rather than a link; not investigated further.

Rebuilds the page on the shape of the Model Context Protocol org profile
README: logo, badges, tagline, nav, intro, Getting Started, Project
Structure, then the tail sections.

Link fixes:
- codeanalyzer-ts and cocoa-py resolved only via GitHub rename redirects
- the Discord link was a discord.com/channels deep-link, which resolves
  only for existing members; replaced with the public invite
- the Contact table displayed rangeet.pan@ibm.com but the mailto pointed
  at gmail
- the <picture> fallback <img> had no src attribute
- badge.fury.io and opensource.org/licenses both redirected; pointed at
  their canonical targets

Removed: the Supported Languages table (backends moved into Project
Structure, status collapsed to one sentence), the Language-Specific
Analysis Backends section, Build with CLDK and every COCOA reference, the
duplicated Documentation and Examples section, the second code example,
the commented-out npm badge, and links to the go/rust stubs and the
0.0.0-pre-alpha npm package.

143 lines to 104.
@rahlk
rahlk force-pushed the docs/issue-28-readme-cleanup branch from 3a387bf to 6239a0c Compare August 3, 2026 16:29
@rahlk
rahlk merged commit c9ea8b9 into main Aug 3, 2026
@rahlk
rahlk deleted the docs/issue-28-readme-cleanup branch August 3, 2026 16:30
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.

Org profile README has stale repo links, a member-only Discord URL, and duplicated sections

1 participant