Repository navigation
Remove the unpublished MCP and Workspace products from the docs - #98
Merged
Merged
Conversation
why: The MCP and workspace rocks are `_VERSION` stubs that are not on LuaRocks and serve nothing. The READMEs still listed them in a Packages table, linked their pages on libtmux.org, and told readers how to build them, which presents products that do not exist as part of the port. what: - Replace the root README Packages table and its two scaffold sections with a single "The library" section, and drop the scaffold sentence, contents entry and "leaves out" bullet (`README.md`) - Remove the "Other packages" section and its contents entry from the core README (`lua/libtmux/README.md`) - Drop the MCP/workspace mention from the project summary, the logo asset notes, the contributor and writing guides, and the compatibility page (`AGENTS.md`, `assets/README.md`, `.github/CONTRIBUTING.md`, `.github/WRITING.md`, `docs/compatibility.md`) - Point changelog guidance at CHANGES.md alone, the changelog of the one rock the repository keeps
why: The changelog opened by pointing at the MCP and workspace rock changelogs, which describe stubs that never had a release. Those files are removed with the scaffolds, so the links would break the docs gate. what: - Remove the paragraph that names the other rocks' changelogs from the top of `CHANGES.md`; no release section changes
why: packages/mcp and packages/workspace each hold a module that returns only `_VERSION`, a README, a changelog and logos. Their rockspecs are scm-1 only and neither rock is on LuaRocks. The check scripts, rockspec guard and tooling tests still enumerated them, so the stubs cost a rockspec build, an import test and a changelog rule apiece for products that do not exist. what: - Delete `packages/mcp`, `packages/workspace` and their `scm-1` rockspecs - Drop the two modules from the LuaLS library path and the Lua path the check runner builds, and drop `packages` from the format and lint targets and the docs gate globs (`.luarc.json`, `scripts/check.py`) - Reduce the package gate's rock, dependency and changelog tables to `libtmux`, and its installed-closure check to the core boundary (`scripts/package.py`) - List only the core changelog, and drop the rule that a non-core rockspec installs its own (`scripts/release.py`) - Check READMEs against the one logo alt text and the core module source (`scripts/readme_examples.py`) - Remove the two import tests and the scaffold fixtures, and run the README, release and changelog tests against the core files (`tests/unit/imports.lua`, `tests/tooling/test_readme_examples.py`, `tests/tooling/test_release.py`, `tests/tooling/test_docs_export.py`)
why: The MCP and workspace rocks are removed because neither was ever published. Their per-rock changelogs held no release and were left behind only so the code removal commit would not also edit changelog files. what: - Delete `packages/mcp/CHANGELOG.md` and `packages/workspace/CHANGELOG.md`
This branch was successfully deployed
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.
Removes every mention of and link to this port's MCP server and Workspace Manager products that have no published package, per the maintainer's rule that an unpublished product gets no page and no link anywhere. libtmux.org drops the matching pages in libtmux/docs#303.