reqlanOverviewIdeasFilesCode filesClustersAttributesGraphPrint

Idea detail

npm_package_readme

reqlan rq/distribution/distribution.rq:64

block

Summary

Publishable npm packages ( `@reqlan/language`, `@reqlan/analytical`, `@reqlan/cli` ) ship README. md generated from each package's `README.template.md`.
Pattern matches extension_readme: centered logo, package name, description, features, phonebook links, and Changesets changelog body.
Generated by generate-npm-package-readmes.ts via root `pnpm run build:readme`.
Contact and repository links come from phonebook via phonebook.ts per npm_package_readme_links.

Jump to outbound references

Jump to inbound references

Navigation

Source file

reqlan rq/distribution/distribution.rq

 community 7

community cluster

distribution.rq

file cluster

reqlan rq/distribution

folder cluster

status: Not present

status cluster

tag: Not present

tag cluster

 Printable page

Static print-friendly idea sheet.

Ancestor context

extension_readme

The VSIX package must include a README for the Marketplace and Open VSX listings. Contact and repository links come from [phonebook_reqs.phonebook] via ["../../scripts/phonebook.ts"] per [phonebook_reqs.extension_readme_links]. Release notes are appended from ["../../packages/extension/CHANGELOG.md"], which Changesets maintains per [version_management]. Generated during extension build from ["../../packages/extension/README.template.md"] by ["../../packages/extension/scripts/generate-readme.ts"] per ["../development/build.rq".extension_readme_build].

version_management

Package versions are managed with Changesets via ["../../.changeset/config.json"]. Publishable channels ( each tag-driven ): - Marketplace / Open VSX: ["./distribution.rq".extension_package] ( private npm package; tagged `ext/v*` ) - GitHub Pages: ["./distribution.rq".site_package] ( tagged `site/v*` ) - npm: `@reqlan/language`, `@reqlan/analytical`, and `@reqlan/cli` ( tagged `language/v*`, `analytical/v*`, `cli/v*` ) Internal tool `reqlan-mcp` is ignored by Changesets and marked `private` so it is never published to npm ( distributed with the extension / local MCP config instead ). Contributors record release intent by adding a changeset file when a publishable package changes.

extension_package

The VS Code extension lives in packages / extension with npm package name `reqlan-extension` ( Marketplace / Open VSX id `reqlan.reqlan-extension` ). Its package. json version is the authoritative Marketplace and Open VSX release version.

site_package

The static site lives in site / with npm package name `site`. Its package. json version identifies site releases for tagging.