reqlanOverviewIdeasFilesCode filesClustersAttributesGraphPrint
Ideas/extension_readme

Idea detail

extension_readme

reqlan rq/distribution/distribution.rq:71

block

Summary

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

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.

Attributes

No attributes declared.

Ancestor context

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.

Outbound references

KindIdeaPathSnippet
file_reference ../../packages/extension/CHANGELOG.md packages/extension/CHANGELOG.md CHANGELOG.md
file_reference ../../packages/extension/README.template.md packages/extension/README.template.md README.template.md
file_reference ../../packages/extension/scripts/generate-readme.ts packages/extension/scripts/generate-readme.ts generate-readme.ts
file_reference ../../scripts/phonebook.ts scripts/phonebook.ts phonebook.ts
references version_management reqlan rq/distribution/distribution.rq version_management

Inbound references

KindIdeaPathSnippet
references npm_package_readme reqlan rq/distribution/distribution.rq extension_readme

Unresolved references

KindIdeaPathSnippet
references extension_readme_build extension_readme_build
references extension_readme_links extension_readme_links
references phonebook phonebook

Local graph

Initialising graph…